LibreOffice
LibreOffice 24.2 SDK API Reference
Loading...
Searching...
No Matches
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
53{
57
62
69 string getContext();
70
76 sequence<XPackageTypeInfo> getSupportedPackageTypes();
77
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,
111 raises (DeploymentException,
115
133 [in] com::sun::star::task::XAbortChannel xAbortChannel,
135 raises (DeploymentException,
139
152 void removePackage( [in] string identifier,
153 [in] string fileName,
154 [in] com::sun::star::task::XAbortChannel xAbortChannel,
156 raises (DeploymentException,
160
173 [in] string identifier,
174 [in] string fileName,
176 raises (DeploymentException,
179
190 sequence<XPackage> getDeployedPackages(
191 [in] com::sun::star::task::XAbortChannel xAbortChannel,
193 raises (DeploymentException,
197
214 [in] boolean force,
215 [in] com::sun::star::task::XAbortChannel xAbortChannel,
217 raises (DeploymentException,
221
235 boolean isReadOnly();
236
254 raises (DeploymentException,
258
259
274 raises (DeploymentException);
275
285 [in] XPackage extension,
286 [in] com::sun::star::task::XAbortChannel xAbortChannel,
288 raises (DeploymentException,
292
293};
294
295}; }; }; };
296
297/* 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
This exception is thrown to indicate that the creation of a UCB content failed.
Definition ContentCreationException.idl:29
The XPackageManager interface is used to add or remove packages to a specific repository.
Definition XPackageManager.idl:53
XPackage getDeployedPackage([in] string identifier, [in] string fileName, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
gets a deployed package.
XPackage importExtension([in] XPackage extension, [in] com::sun::star::task::XAbortChannel xAbortChannel, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv)
adds an extension.
sequence< XPackageTypeInfo > getSupportedPackageTypes()
gets the supported XPackageTypeInfos.
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.
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.
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.
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.
boolean isReadOnly()
indicates that this implementation cannot be used for tasks which require write access to the locatio...
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::task::XAbortChannel createAbortChannel()
creates a command channel to be used to asynchronously abort a command.
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.
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.
string getContext()
returns the underlying deployment context, that is, the name of the repository.
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