LibreOffice
LibreOffice 7.4 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
20#ifndef _com_sun_star_deployment_XExtensionManager_idl
21#define _com_sun_star_deployment_XExtensionManager_idl
22
33
34module com { module sun { module star { module deployment {
35
43{
47
52
53
59 sequence<XPackageTypeInfo> getSupportedPackageTypes();
60
67
88 XPackage addExtension( [in] string url,
89 [in] sequence<com::sun::star::beans::NamedValue> properties,
90 [in] string repository,
91 [in] com::sun::star::task::XAbortChannel xAbortChannel,
93 raises (DeploymentException,
97
113 [in] string identifier,
114 [in] string fileName,
115 [in] string repository,
116 [in] com::sun::star::task::XAbortChannel xAbortChannel,
118 raises (DeploymentException,
122
123
138 [in] XPackage extension,
139 [in] com::sun::star::task::XAbortChannel xAbortChannel,
141 raises (DeploymentException,
145
160 [in] XPackage extension,
161 [in] com::sun::star::task::XAbortChannel xAbortChannel,
163 raises (DeploymentException,
167
181 sequence<XPackage> getDeployedExtensions(
182 [in] string repository,
183 [in] com::sun::star::task::XAbortChannel xAbortChannel,
185 raises (DeploymentException,
189
190
205 [in] string repository,
206 [in] string identifier,
207 [in] string fileName,
209 raises (DeploymentException,
212
222 [in] string identifier,
223 [in] string fileName,
225 raises (DeploymentException,
228
229
239 sequence<sequence<XPackage> > getAllExtensions(
240 [in] com::sun::star::task::XAbortChannel xAbortChannel,
242 raises (DeploymentException,
246
247
265 [in] boolean force,
266 [in] string repository,
267 [in] com::sun::star::task::XAbortChannel xAbortChannel,
269 raises (DeploymentException,
273
274
287 boolean synchronize(
288 [in] com::sun::star::task::XAbortChannel xAbortChannel,
290 raises (DeploymentException,
294
314 [in] string repository,
316 raises (DeploymentException,
318
323 [in] XPackage extension,
324 [in] com::sun::star::task::XAbortChannel xAbortChannel,
326 raises (DeploymentException,
330
334 boolean isReadOnlyRepository([in] string repository);
335};
336
337}; }; }; };
338
339#endif
340
341/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
A DeploymentException reflects a deployment error.
Definition DeploymentException.idl:33
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:31
This exception is thrown to indicate that a command was aborted.
Definition CommandAbortedException.idl:34
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition CommandFailedException.idl:40
The XExtensionManager interface is used to manage extensions in the user, shared and bundled reposito...
Definition XExtensionManager.idl:43
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.
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.
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
boolean isReadOnlyRepository([in] string repository)
determines if the current user has write access to the extensions folder of the repository.
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.
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.
void enableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
enable an extension.
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.
void disableExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
disable an extension.
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.
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::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
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.
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.
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 ...
Objects of this interface reflect a bound package and are issued by a PackageRegistryBackend.
Definition XPackage.idl:47
allows to explicitly free resources and break cyclic references.
Definition XComponent.idl:43
Use this interface to abort a command asynchronously.
Definition XAbortChannel.idl:31
defines the environment for a command.
Definition XCommandEnvironment.idl:36
broadcasts each modification made on the date data of the object which supports this interface.
Definition XModifyBroadcaster.idl:38
Definition Ambiguous.idl:22