LibreOffice: com/sun/star/deployment/XExtensionManager.idl Source File

LibreOffice LibreOffice 24.8 SDK API Reference |

Loading...
Searching...
No Matches
XExtensionManager.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
20module com { module sun { module star { module deployment {
21
28 interface XExtensionManager
29{
32 interface com::sun::star::lang::XComponent;
33
37 interface com::sun::star::util::XModifyBroadcaster;
38
39
45 sequence<XPackageTypeInfo> getSupportedPackageTypes();
46
52 com::sun::star::task::XAbortChannel createAbortChannel();
53
74 XPackage addExtension( [in] string url,
75 [in] sequence<com::sun::star::beans::NamedValue> properties,
76 [in] string repository,
77 [in] com::sun::star::task::XAbortChannel xAbortChannel,
78 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
79 raises (DeploymentException,
80 com::sun::star::ucb::CommandFailedException,
81 com::sun::star::ucb::CommandAbortedException,
82 com::sun::star::lang::IllegalArgumentException);
83
98 void removeExtension(
99 [in] string identifier,
100 [in] string fileName,
101 [in] string repository,
102 [in] com::sun::star::task::XAbortChannel xAbortChannel,
103 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
104 raises (DeploymentException,
105 com::sun::star::ucb::CommandFailedException,
106 com::sun::star::ucb::CommandAbortedException,
107 com::sun::star::lang::IllegalArgumentException);
108
109
123 void enableExtension(
124 [in] XPackage extension,
125 [in] com::sun::star::task::XAbortChannel xAbortChannel,
126 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
127 raises (DeploymentException,
128 com::sun::star::ucb::CommandFailedException,
129 com::sun::star::ucb::CommandAbortedException,
130 com::sun::star::lang::IllegalArgumentException);
131
145 void disableExtension(
146 [in] XPackage extension,
147 [in] com::sun::star::task::XAbortChannel xAbortChannel,
148 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
149 raises (DeploymentException,
150 com::sun::star::ucb::CommandFailedException,
151 com::sun::star::ucb::CommandAbortedException,
152 com::sun::star::lang::IllegalArgumentException);
153
167 sequence<XPackage> getDeployedExtensions(
168 [in] string repository,
169 [in] com::sun::star::task::XAbortChannel xAbortChannel,
170 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
171 raises (DeploymentException,
172 com::sun::star::ucb::CommandFailedException,
173 com::sun::star::ucb::CommandAbortedException,
174 com::sun::star::lang::IllegalArgumentException);
175
176
190 XPackage getDeployedExtension(
191 [in] string repository,
192 [in] string identifier,
193 [in] string fileName,
194 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
195 raises (DeploymentException,
196 com::sun::star::ucb::CommandFailedException,
197 com::sun::star::lang::IllegalArgumentException);
198
207 sequence<XPackage> getExtensionsWithSameIdentifier(
208 [in] string identifier,
209 [in] string fileName,
210 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
211 raises (DeploymentException,
212 com::sun::star::ucb::CommandFailedException,
213 com::sun::star::lang::IllegalArgumentException);
214
215
225 sequence<sequence<XPackage> > getAllExtensions(
226 [in] com::sun::star::task::XAbortChannel xAbortChannel,
227 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
228 raises (DeploymentException,
229 com::sun::star::ucb::CommandFailedException,
230 com::sun::star::ucb::CommandAbortedException,
231 com::sun::star::lang::IllegalArgumentException);
232
233
250 void reinstallDeployedExtensions(
251 [in] boolean force,
252 [in] string repository,
253 [in] com::sun::star::task::XAbortChannel xAbortChannel,
254 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
255 raises (DeploymentException,
256 com::sun::star::ucb::CommandFailedException,
257 com::sun::star::ucb::CommandAbortedException,
258 com::sun::star::lang::IllegalArgumentException);
259
260
273 boolean synchronize(
274 [in] com::sun::star::task::XAbortChannel xAbortChannel,
275 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
276 raises (DeploymentException,
277 com::sun::star::ucb::CommandFailedException,
278 com::sun::star::ucb::CommandAbortedException,
279 com::sun::star::lang::IllegalArgumentException);
280
299 sequence<XPackage> getExtensionsWithUnacceptedLicenses(
300 [in] string repository,
301 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
302 raises (DeploymentException,
303 com::sun::star::lang::IllegalArgumentException);
304
308 long checkPrerequisitesAndEnable(
309 [in] XPackage extension,
310 [in] com::sun::star::task::XAbortChannel xAbortChannel,
311 [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv )
312 raises (DeploymentException,
313 com::sun::star::ucb::CommandFailedException,
314 com::sun::star::ucb::CommandAbortedException,
315 com::sun::star::lang::IllegalArgumentException);
316
320 boolean isReadOnlyRepository([in] string repository);
321};
322
323}; }; }; };
324
325/* 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::deployment::XExtensionManager
The XExtensionManager interface is used to manage extensions in the user, shared and bundled reposito...
Definition XExtensionManager.idl:29
com::sun::star::deployment::XExtensionManager::removeExtension
void removeExtension([in] string identifier, [in] string fileName, [in] string repository, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
removes an extension.
com::sun::star::deployment::XExtensionManager::addExtension
XPackage addExtension([in] string url, [in] sequence< com::sun::star::beans::NamedValue > properties, [in] string repository, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
adds an extension.
com::sun::star::deployment::XExtensionManager::getSupportedPackageTypes
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
com::sun::star::deployment::XExtensionManager::isReadOnlyRepository
boolean isReadOnlyRepository([in] string repository)
determines if the current user has write access to the extensions folder of the repository.
com::sun::star::deployment::XExtensionManager::getDeployedExtensions
sequence< XPackage > getDeployedExtensions([in] string repository, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets all currently installed extensions, including disabled user extensions.
com::sun::star::deployment::XExtensionManager::getAllExtensions
sequence< sequence< XPackage > > getAllExtensions([in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
returns a sequence containing all installed extensions.
com::sun::star::deployment::XExtensionManager::enableExtension
void enableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
enable an extension.
com::sun::star::deployment::XExtensionManager::checkPrerequisitesAndEnable
long checkPrerequisitesAndEnable([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
check if all prerequisites for the extension are fulfilled and activates it, if possible.
com::sun::star::deployment::XExtensionManager::disableExtension
void disableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
disable an extension.
com::sun::star::deployment::XExtensionManager::getExtensionsWithUnacceptedLicenses
sequence< XPackage > getExtensionsWithUnacceptedLicenses([in] string repository, [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::XExtensionManager::getDeployedExtension
XPackage getDeployedExtension([in] string repository, [in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets an installed extensions.
com::sun::star::deployment::XExtensionManager::createAbortChannel
com::sun::star::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
com::sun::star::deployment::XExtensionManager::getExtensionsWithSameIdentifier
sequence< XPackage > getExtensionsWithSameIdentifier([in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets all extensions with the same identifier from all repositories.
com::sun::star::deployment::XExtensionManager::reinstallDeployedExtensions
void reinstallDeployedExtensions([in] boolean force, [in] string repository, [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 extensions.
com::sun::star::deployment::XExtensionManager::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 of shared and bundled ...
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