LibreOffice LibreOffice 25.8 SDK API Reference

XPackageManager.idl
Go to the documentation of this file.
1/* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*- */
2/*
3 * This file is part of the LibreOffice project.
4 *
5 * This Source Code Form is subject to the terms of the Mozilla Public
6 * License, v. 2.0. If a copy of the MPL was not distributed with this
7 * file, You can obtain one at http://mozilla.org/MPL/2.0/.
8 *
9 * This file incorporates work covered by the following license notice:
10 *
11 * Licensed to the Apache Software Foundation (ASF) under one or more
12 * contributor license agreements. See the NOTICE file distributed
13 * with this work for additional information regarding copyright
14 * ownership. The ASF licenses this file to you under the Apache
15 * License, Version 2.0 (the "License"); you may not use this file
16 * except in compliance with the License. You may obtain a copy of
17 * the License at http://www.apache.org/licenses/LICENSE-2.0 .
18 */
19
20
21module com { module sun { module star { module deployment {
22
52 interface XPackageManager
53{
56 interface com::sun::star::lang::XComponent;
57
61 interface com::sun::star::util::XModifyBroadcaster;
62
69 string getContext();
70
76 sequence<XPackageTypeInfo> getSupportedPackageTypes();
77
83 com::sun::star::task::XAbortChannel createAbortChannel();
84
106 XPackage addPackage( [in] string url,
107 [in] sequence<com::sun::star::beans::NamedValue> properties,
108 [in] string mediaType,
109 [in] com::sun::star::task::XAbortChannel xAbortChannel,
110 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
111 raises (DeploymentException,
112 com::sun::star::ucb::CommandFailedException,
113 com::sun::star::ucb::CommandAbortedException,
114 com::sun::star::lang::IllegalArgumentException);
115
132 XPackage importExtension( [in] XPackage extension,
133 [in] com::sun::star::task::XAbortChannel xAbortChannel,
134 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
135 raises (DeploymentException,
136 com::sun::star::ucb::CommandFailedException,
137 com::sun::star::ucb::CommandAbortedException,
138 com::sun::star::lang::IllegalArgumentException);
139
152 void removePackage( [in] string identifier,
153 [in] string fileName,
154 [in] com::sun::star::task::XAbortChannel xAbortChannel,
155 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
156 raises (DeploymentException,
157 com::sun::star::ucb::CommandFailedException,
158 com::sun::star::ucb::CommandAbortedException,
159 com::sun::star::lang::IllegalArgumentException);
160
172 XPackage getDeployedPackage(
173 [in] string identifier,
174 [in] string fileName,
175 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
176 raises (DeploymentException,
177 com::sun::star::ucb::CommandFailedException,
178 com::sun::star::lang::IllegalArgumentException);
179
190 sequence<XPackage> getDeployedPackages(
191 [in] com::sun::star::task::XAbortChannel xAbortChannel,
192 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
193 raises (DeploymentException,
194 com::sun::star::ucb::CommandFailedException,
195 com::sun::star::ucb::CommandAbortedException,
196 com::sun::star::lang::IllegalArgumentException);
197
213 void reinstallDeployedPackages(
214 [in] boolean force,
215 [in] com::sun::star::task::XAbortChannel xAbortChannel,
216 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
217 raises (DeploymentException,
218 com::sun::star::ucb::CommandFailedException,
219 com::sun::star::ucb::CommandAbortedException,
220 com::sun::star::lang::IllegalArgumentException);
221
235 boolean isReadOnly();
236
252 boolean synchronize([in] com::sun::star::task::XAbortChannel xAbortChannel,
253 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
254 raises (DeploymentException,
255 com::sun::star::ucb::ContentCreationException,
256 com::sun::star::ucb::CommandFailedException,
257 com::sun::star::ucb::CommandAbortedException);
258
259
272 sequence<XPackage> getExtensionsWithUnacceptedLicenses(
273 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
274 raises (DeploymentException);
275
284 long checkPrerequisites(
285 [in] XPackage extension,
286 [in] com::sun::star::task::XAbortChannel xAbortChannel,
287 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
288 raises (DeploymentException,
289 com::sun::star::ucb::CommandFailedException,
290 com::sun::star::ucb::CommandAbortedException,
291 com::sun::star::lang::IllegalArgumentException);
292
293};
294
295}; }; }; };
296
297/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::deployment::DeploymentException
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:28
com::sun::star::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:27
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:30
com::sun::star::ucb::CommandFailedException
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition: CommandFailedException.idl:35
com::sun::star::ucb::ContentCreationException
This exception is thrown to indicate that the creation of a UCB content failed.
Definition: ContentCreationException.idl:29
com::sun::star::deployment::XPackageManager
The XPackageManager interface is used to add or remove packages to a specific repository.
Definition: XPackageManager.idl:53
com::sun::star::deployment::XPackageManager::getDeployedPackage
XPackage getDeployedPackage([in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets a deployed package.
com::sun::star::deployment::XPackageManager::importExtension
XPackage importExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
adds an extension.
com::sun::star::deployment::XPackageManager::getSupportedPackageTypes
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
com::sun::star::deployment::XPackageManager::checkPrerequisites
long checkPrerequisites([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
checks if the extension can be used.
com::sun::star::deployment::XPackageManager::addPackage
XPackage addPackage([in] string url, [in] sequence< com::sun::star::beans::NamedValue > properties, [in] string mediaType, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
adds a UNO package.
com::sun::star::deployment::XPackageManager::removePackage
void removePackage([in] string identifier, [in] string fileName, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
removes a UNO package.
com::sun::star::deployment::XPackageManager::reinstallDeployedPackages
void reinstallDeployedPackages([in] boolean force, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
Expert feature: erases the underlying registry cache and reinstalls all previously added packages.
com::sun::star::deployment::XPackageManager::isReadOnly
boolean isReadOnly()
indicates that this implementation cannot be used for tasks which require write access to the locatio...
com::sun::star::deployment::XPackageManager::getDeployedPackages
sequence< XPackage > getDeployedPackages([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets all currently deployed packages.
com::sun::star::deployment::XPackageManager::createAbortChannel
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
com::sun::star::deployment::XPackageManager::getExtensionsWithUnacceptedLicenses
sequence< XPackage > getExtensionsWithUnacceptedLicenses([in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
returns all extensions which are currently not in use because the user did not accept the license.
com::sun::star::deployment::XPackageManager::synchronize
boolean synchronize([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
synchronizes the extension database with the contents of the extensions folder.
com::sun::star::deployment::XPackageManager::getContext
string getContext()
returns the underlying deployment context, that is, the name of the repository.
com::sun::star::deployment::XPackage
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:29
com::sun::star::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:39
com::sun::star::task::XAbortChannel
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:27
com::sun::star::ucb::XCommandEnvironment
defines the environment for a command.
Definition: XCommandEnvironment.idl:29
com::sun::star::util::XModifyBroadcaster
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:32
com
Definition: Ambiguous.idl:20