LibreOffice
LibreOffice 6.4 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 #ifndef _com_sun_star_deployment_XPackageManager_idl
21 #define _com_sun_star_deployment_XPackageManager_idl
22 
33 
34 
35 module com { module sun { module star { module deployment {
36 
66 interface XPackageManager
67 {
71 
76 
83  string getContext();
84 
90  sequence<XPackageTypeInfo> getSupportedPackageTypes();
91 
98 
120  XPackage addPackage( [in] string url,
121  [in] sequence<com::sun::star::beans::NamedValue> properties,
122  [in] string mediaType,
123  [in] com::sun::star::task::XAbortChannel xAbortChannel,
125  raises (DeploymentException,
129 
147  [in] com::sun::star::task::XAbortChannel xAbortChannel,
149  raises (DeploymentException,
153 
166  void removePackage( [in] string identifier,
167  [in] string fileName,
168  [in] com::sun::star::task::XAbortChannel xAbortChannel,
170  raises (DeploymentException,
174 
187  [in] string identifier,
188  [in] string fileName,
190  raises (DeploymentException,
193 
204  sequence<XPackage> getDeployedPackages(
205  [in] com::sun::star::task::XAbortChannel xAbortChannel,
207  raises (DeploymentException,
211 
228  [in] boolean force,
229  [in] com::sun::star::task::XAbortChannel xAbortChannel,
231  raises (DeploymentException,
235 
249  boolean isReadOnly();
250 
268  raises (DeploymentException,
272 
273 
288  raises (DeploymentException);
289 
299  [in] XPackage extension,
300  [in] com::sun::star::task::XAbortChannel xAbortChannel,
302  raises (DeploymentException,
306 
307 };
308 
309 }; }; }; };
310 
311 #endif
312 
313 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */
com::sun::star::deployment::XPackageManager::getSupportedPackageTypes
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
XPackage.idl
com::sun::star::task::XAbortChannel
Use this interface to abort a command asynchronously.
Definition: XAbortChannel.idl:31
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::ucb::CommandFailedException
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition: CommandFailedException.idl:40
XComponent.idl
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::ucb::XCommandEnvironment
defines the environment for a command.
Definition: XCommandEnvironment.idl:36
XAbortChannel.idl
com::sun::star::deployment::XPackage
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition: XPackage.idl:47
com::sun::star::deployment::XPackageManager
The XPackageManager interface is used to add or remove packages to a specific repository.
Definition: XPackageManager.idl:67
XCommandEnvironment.idl
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::lang::XComponent
allows to explicitly free resources and break cyclic references.
Definition: XComponent.idl:43
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.
XPackageTypeInfo.idl
com::sun::star::ucb::ContentCreationException
This exception is thrown to indicate that the creation of a UCB content failed.
Definition: ContentCreationException.idl:34
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::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::getContext
string getContext()
returns the underlying deployment context, that is, the name of the repository.
com::sun::star::ucb::CommandAbortedException
This exception is thrown to indicate that a command was aborted.
Definition: CommandAbortedException.idl:34
DeploymentException.idl
com::sun::star::deployment::DeploymentException
A DeploymentException reflects a deployment error.
Definition: DeploymentException.idl:33
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
Definition: Ambiguous.idl:22
NoSuchElementException.idl
com::sun::star::util::XModifyBroadcaster
broadcasts each modification made on the date data of the object which supports this interface.
Definition: XModifyBroadcaster.idl:38
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::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::lang::IllegalArgumentException
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition: IllegalArgumentException.idl:31
com::sun::star::deployment::XPackageManager::createAbortChannel
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
IllegalArgumentException.idl
XModifyBroadcaster.idl
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.
NamedValue.idl