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
29{
33
38
39
45 sequence<XPackageTypeInfo> getSupportedPackageTypes();
46
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,
79 raises (DeploymentException,
83
99 [in] string identifier,
100 [in] string fileName,
101 [in] string repository,
102 [in] com::sun::star::task::XAbortChannel xAbortChannel,
104 raises (DeploymentException,
108
109
124 [in] XPackage extension,
125 [in] com::sun::star::task::XAbortChannel xAbortChannel,
127 raises (DeploymentException,
131
146 [in] XPackage extension,
147 [in] com::sun::star::task::XAbortChannel xAbortChannel,
149 raises (DeploymentException,
153
167 sequence<XPackage> getDeployedExtensions(
168 [in] string repository,
169 [in] com::sun::star::task::XAbortChannel xAbortChannel,
171 raises (DeploymentException,
175
176
191 [in] string repository,
192 [in] string identifier,
193 [in] string fileName,
195 raises (DeploymentException,
198
208 [in] string identifier,
209 [in] string fileName,
211 raises (DeploymentException,
214
215
225 sequence<sequence<XPackage> > getAllExtensions(
226 [in] com::sun::star::task::XAbortChannel xAbortChannel,
228 raises (DeploymentException,
232
233
251 [in] boolean force,
252 [in] string repository,
253 [in] com::sun::star::task::XAbortChannel xAbortChannel,
255 raises (DeploymentException,
259
260
273 boolean synchronize(
274 [in] com::sun::star::task::XAbortChannel xAbortChannel,
276 raises (DeploymentException,
280
300 [in] string repository,
302 raises (DeploymentException,
304
309 [in] XPackage extension,
310 [in] com::sun::star::task::XAbortChannel xAbortChannel,
312 raises (DeploymentException,
316
320 boolean isReadOnlyRepository([in] string repository);
321};
322
323}; }; }; };
324
325/* vim:set shiftwidth=4 softtabstop=4 expandtab: */
A DeploymentException reflects a deployment error.
Definition DeploymentException.idl:28
This exception is thrown to indicate that a method has passed an illegal or inappropriate argument.
Definition IllegalArgumentException.idl:27
This exception is thrown to indicate that a command was aborted.
Definition CommandAbortedException.idl:30
This exception is thrown if an exception situation occurred during the processing of a command and an...
Definition CommandFailedException.idl:35
The XExtensionManager interface is used to manage extensions in the user, shared and bundled reposito...
Definition XExtensionManager.idl:29
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:29
allows to explicitly free resources and break cyclic references.
Definition generated_idl_chapter_refs.idl:435
Use this interface to abort a command asynchronously.
Definition XAbortChannel.idl:27
defines the environment for a command.
Definition XCommandEnvironment.idl:29
broadcasts each modification made on the date data of the object which supports this interface.
Definition XModifyBroadcaster.idl:32
Definition Ambiguous.idl:20