summaryrefslogtreecommitdiffstats
path: root/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-07 09:06:44 +0000
commited5640d8b587fbcfed7dd7967f3de04b37a76f26 (patch)
tree7a5f7c6c9d02226d7471cb3cc8fbbf631b415303 /offapi/com/sun/star/deployment/XUpdateInformationProvider.idl
parentInitial commit. (diff)
downloadlibreoffice-upstream/4%7.4.7.tar.xz
libreoffice-upstream/4%7.4.7.zip
Adding upstream version 4:7.4.7.upstream/4%7.4.7upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'offapi/com/sun/star/deployment/XUpdateInformationProvider.idl')
-rw-r--r--offapi/com/sun/star/deployment/XUpdateInformationProvider.idl105
1 files changed, 105 insertions, 0 deletions
diff --git a/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl
new file mode 100644
index 000000000..882d59f80
--- /dev/null
+++ b/offapi/com/sun/star/deployment/XUpdateInformationProvider.idl
@@ -0,0 +1,105 @@
+/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
+/*
+ * This file is part of the LibreOffice project.
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ *
+ * This file incorporates work covered by the following license notice:
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed
+ * with this work for additional information regarding copyright
+ * ownership. The ASF licenses this file to you under the Apache
+ * License, Version 2.0 (the "License"); you may not use this file
+ * except in compliance with the License. You may obtain a copy of
+ * the License at http://www.apache.org/licenses/LICENSE-2.0 .
+ */
+
+#ifndef __com_sun_star_deployment_XUpdateInformationProvider_idl__
+#define __com_sun_star_deployment_XUpdateInformationProvider_idl__
+
+#include <com/sun/star/uno/XInterface.idl>
+#include <com/sun/star/uno/Exception.idl>
+
+module com { module sun { module star { module container {
+interface XEnumeration;
+}; }; }; };
+
+module com { module sun { module star { module task {
+interface XInteractionHandler;
+}; }; }; };
+
+module com { module sun { module star { module xml { module dom {
+interface XElement;
+}; }; }; }; };
+
+module com { module sun { module star { module deployment {
+
+/** Objects implementing this interface provide access to the xml root of
+ one or more update information files for a given set of URLs.
+
+ @since OOo 2.2
+*/
+interface XUpdateInformationProvider
+{
+ /** get update information for a specific extension or all available
+ information from a repository.
+
+ @param repositories
+ a repository and its mirrors.
+ @param extensionId
+ the unique identifier of an extension. If it is not empty and
+ the update document is an atom feed, only items whose "term"
+ attribute of the atom:category tag matches extensionId are returned.
+
+ */
+ sequence < com::sun::star::xml::dom::XElement > getUpdateInformation(
+ [in] sequence< string > repositories,
+ [in] string extensionId
+ ) raises ( com::sun::star::uno::Exception );
+
+ /** interrupts a getUpdateInformation call and let's it return immediately.
+ */
+ void cancel();
+
+ /** Sets an interaction handler to be used for further operations.
+
+ <p>
+ A default interaction handler is available as service
+ com::sun::star::task::InteractionHandler.
+ The documentation of this service also contains further
+ information about the interaction handler concept.
+ </p>
+
+ @see com::sun::star::task::InteractionHandler
+
+ @param handler
+ The interaction handler to be set
+ */
+ void setInteractionHandler( [in] com::sun::star::task::XInteractionHandler handler );
+
+ /** get update information for a specific extension or all available
+ information from a repository.
+
+ @param repositories
+ a repository and its mirrors.
+ @param extensionId
+ the unique identifier of an extension. If it is not empty and
+ the update document is an atom feed, only items whose "term"
+ attribute of the atom:category tag matches extensionId are returned.
+
+ @returns
+ an enumeration of UpdateInformationEntry.
+ */
+ com::sun::star::container::XEnumeration getUpdateInformationEnumeration(
+ [in] sequence< string > repositories,
+ [in] string extensionId
+ ) raises ( com::sun::star::uno::Exception );
+};
+
+}; }; }; };
+#endif
+
+/* vim:set shiftwidth=4 softtabstop=4 expandtab: */