LibreOffice
LibreOffice 6.2 SDK API Reference
Public Member Functions | List of all members
XPackageRegistry Interface Reference

Interface to bind an UNO package. More...

import"XPackageRegistry.idl";

Inheritance diagram for XPackageRegistry:
PackageRegistryBackend

Public Member Functions

XPackage bindPackage ([in] string url, [in] string mediaType, [in] boolean removed, [in] string identifier, [in] com::sun::star::ucb::XCommandEnvironment xCmdEnv) raises (DeploymentException, InvalidRemovedParameterException, com::sun::star::ucb::CommandFailedException, com::sun::star::lang::IllegalArgumentException)
 binds a package URL to a XPackage handle. More...
 
sequence< XPackageTypeInfogetSupportedPackageTypes ()
 gets the supported XPackageTypeInfos. More...
 
void packageRemoved ([in] string url, [in] string mediaType) raises (DeploymentException, com::sun::star::lang::IllegalArgumentException)
 

Detailed Description

Interface to bind an UNO package.

Since
OOo 2.0

Member Function Documentation

XPackage bindPackage ( [in] string  url,
[in] string  mediaType,
[in] boolean  removed,
[in] string  identifier,
[in] com::sun::star::ucb::XCommandEnvironment  xCmdEnv 
)
raises (DeploymentException,
InvalidRemovedParameterException,
com::sun::star::ucb::CommandFailedException,
com::sun::star::lang::IllegalArgumentException
)

binds a package URL to a XPackage handle.

The returned UNO package handle ought to late-initialize itself, thus the process of binding must not be an expensive operation, because it is not abortable.

Calling the function several time with the same parameters must result in returning the same object.

The file or folder at the location where url points to may not exist or it was replaced. This can happen, for example, when a bundled extension was removed by the setup and a user later starts OOo. Then the user data may still contain all registration data of that extension, but the actual extension files do not exist anymore. The registration data must then be cleaned of all the remains of that extension. To do that one creates an XPackage object on behalf of that extension and calls XPackage::revokePakage(). The parameter removed indicates this case. The returned object may not rely on the file or folder to which refers url. Instead it must use previously saved data to successfully carry out the revocation of this object (XPackage::revokePackage()).

The implementation must ensure that there is only one instance of XPackage for the same url at any time. Therefore calling bindPackage() again with the same url but different mediaType (the exception is, if previously an empty string was provided to cause the determination of the media type) or removed parameters will cause an exception. An com::sun::star::lang::IllegalArgumentException will be thrown in case of a different mediaType parameter and a InvalidRemovedParameterException is thrown if the removed parameter is different.

The identifier parameter must be provided when removed = true. If not, then an com::sun::star::lang::IllegalArgumentException will be thrown.

Parameters
urlpackage URL, must be UCB conform
mediaTypemedia type of package, empty string if to be detected
removed
identifierthe identifier of the extension
xCmdEnvcommand environment for error and progress handling
Returns
XPackage handle
sequence<XPackageTypeInfo> getSupportedPackageTypes ( )

gets the supported XPackageTypeInfos.

Returns
supported XPackageTypeInfos.
void packageRemoved ( [in] string  url,
[in] string  mediaType 
)
raises (DeploymentException,
com::sun::star::lang::IllegalArgumentException
)

The documentation for this interface was generated from the following file: