<html> <head> <title>Interface XExtensionManager</title> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <link rel="stylesheet" type="text/css" href="../../../../idl.css"> </head> <body> <div id="adc-idlref"> <a name="_top_"> </a><table class="navimain" border="0" cellpadding="3"> <tr> <td class="navimain"><a href="../module-ix.html" class="navimain">Overview</a></td> <td class="navimain"><a href="module-ix.html" class="navimain">Module</a></td> <td class="navimain"><a href="XExtensionManager-xref.html" class="navimain">Use</a></td> <td class="navimainnone">Devguide</td> <td class="navimain"><a href="../../../../index-files/index-1.html" class="navimain">Index</a></td> </tr> </table> <table class="navisub" border="0" cellpadding="0"> <tr> <td class="navisub"><a href="#MethodsSummary" class="navisub">Methods' Summary</a></td> <td class="navisub">Attributes' Summary</td> <td class="navisub"><a href="#MethodsDetails" class="navisub">Methods' Details</a></td> <td class="navisub">Attributes' Details</td> </tr> </table> <hr> <table border="0" width="100%" cellpadding="5" cellspacing="3" class="title-table" style="margin-bottom:6pt;"> <tr> <td><p class="namechain"><a href="../../../../module-ix.html" class="namechain">::</a> <a href="../../../module-ix.html" class="namechain">com</a> :: <a href="../../module-ix.html" class="namechain">sun</a> :: <a href="../module-ix.html" class="namechain">star</a> :: <a href="module-ix.html" class="namechain">deployment</a> :: </p> </td> </tr> <tr> <td class="title"><table class="title-table" width="99%"> <tr> <td width="25%" class="title2">unpublished </td> <td width="50%" class="title">interface XExtensionManager</td> <td width="*"/></tr> </table> </td> </tr> <tr> <td><dl> <dt><b>Base Interfaces</b></dt> <dd><pre style="font-family:monospace;"><strong>XExtensionManager</strong> ┣ ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a> ┗ ::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a> </pre></dd> <dd><a name/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="crosstitle"> <tr> <td class="imsum_left">::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/XComponent.html">XComponent</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>interface to notify disposing </dd> </dl> </td> </tr> <tr> <td class="imsum_left">::com::sun::star::<a href="../util/module-ix.html">util</a>::<a href="../util/XModifyBroadcaster.html">XModifyBroadcaster</a></td> <td class="imsum_right"><dl> <dt><b>Description</b></dt> <dd>interface to notify changes of the set of deployed packages of this manager </dd> </dl> </td> </tr> </table> </dd> </dl> </td> </tr> <tr> <td><dl> <dt><b>Usage Restrictions</b></dt> <dd><i>not published</i></dd> <dt><b>Description</b></dt> <dd>The <a href="XExtensionManager.html">XExtensionManager</a> interface is used to manage extensions in the user, shared and bundled repository. </dd> <dt><b>Since </b></dt> <dd>OOo 3.3</dd> <dt><b>See also</b></dt> <dd><a href="ExtensionManager.html">ExtensionManager</a></dd> </dl> </td> </tr> </table> <hr> <a name="MethodsSummary"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle" colspan="2">Methods' Summary</td> </tr> <tr> <td class="imsum_left"><a href="#getSupportedPackageTypes">getSupportedPackageTypes</a></td> <td class="imsum_right">gets the supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </td> </tr> <tr> <td class="imsum_left"><a href="#createAbortChannel">createAbortChannel</a></td> <td class="imsum_right">creates a command channel to be used to asynchronously abort a command. </td> </tr> <tr> <td class="imsum_left"><a href="#addExtension">addExtension</a></td> <td class="imsum_right">adds an extension. The properties argument is currently only used to suppress the license information for shared extensions. </td> </tr> <tr> <td class="imsum_left"><a href="#removeExtension">removeExtension</a></td> <td class="imsum_right">removes an extension. </td> </tr> <tr> <td class="imsum_left"><a href="#enableExtension">enableExtension</a></td> <td class="imsum_right">enable an extension. If the extension is not from the user repository then an IllegalArgumentException is thrown. </td> </tr> <tr> <td class="imsum_left"><a href="#disableExtension">disableExtension</a></td> <td class="imsum_right">disable an extension. If the extension is not from the user repository then an IllegalArgumentException is thrown. </td> </tr> <tr> <td class="imsum_left"><a href="#getDeployedExtensions">getDeployedExtensions</a></td> <td class="imsum_right">gets all currently installed extensions, including disabled user extensions. </td> </tr> <tr> <td class="imsum_left"><a href="#getDeployedExtension">getDeployedExtension</a></td> <td class="imsum_right">gets an installed extensions. </td> </tr> <tr> <td class="imsum_left"><a href="#getExtensionsWithSameIdentifier">getExtensionsWithSameIdentifier</a></td> <td class="imsum_right">gets all extensions with the same identifier from all repositories. The extension at the first position in the returned sequence represents the extension from the user repository. The next element is from the shared and the last one is from the bundled repository. If one repository does not contain this extension, then the respective element is a null reference. </td> </tr> <tr> <td class="imsum_left"><a href="#getAllExtensions">getAllExtensions</a></td> <td class="imsum_right">returns a sequence containing all installed extensions. The members of the returned sequence correspond to an extension with a particular extension identifier. The members are also sequences which contain as many elements as there are repositories. Those are ordered according to the priority of the repository. That is, the first member is the extension from the user repository, the second is from the shared repository and the last is from the bundled repository. </td> </tr> <tr> <td class="imsum_left"><a href="#reinstallDeployedExtensions">reinstallDeployedExtensions</a></td> <td class="imsum_right">Expert feature: erases the underlying registry cache and reinstalls all previously added extensions. Please keep in mind that all registration status get lost. </td> </tr> <tr> <td class="imsum_left"><a href="#synchronize">synchronize</a></td> <td class="imsum_right">synchronizes the extension database with the contents of the extensions folder of shared and bundled extensions. Added extensions will be added to the database and removed extensions will be removed from the database. The active extensions are determined. That is, shared or bundled extensions are not necessaryly registered (<a href="XPackage.html">XPackage</a>::<a href="XPackage.html#registerPackage">registerPackage</a>). </td> </tr> <tr> <td class="imsum_left"><a href="#synchronizeBundledPrereg">synchronizeBundledPrereg</a></td> <td class="imsum_right">synchronizes the special bundled_prereg repository, which is based on the bundled extensions and has its registration data folder at $BUNDLED_EXTENSIONS_PREREG (for example openoffice.org3/share/prereg). All bundled extensions are registered (<a href="XPackage.html">XPackage</a>::<a href="XPackage.html#registerPackage">registerPackage</a>). The active extensions are NOT determined, because this function only works with bundled extensions. This function is intended to be called during the installation of OOo. OOo will copy parts of the registration data folder to the user installation at the first startup. </td> </tr> <tr> <td class="imsum_left"><a href="#getExtensionsWithUnacceptedLicenses">getExtensionsWithUnacceptedLicenses</a></td> <td class="imsum_right">returns all extensions which are currently not in use because the user did not accept the license. The function will not return any object for the user repository, because a user extension will not be kept in the user repository if its license is declined. Only extensions which are registered at start-up of OOo, that is, shared and bundled extensions, can be returned. Extensions which allow the license to be suppressed, that is, it does not need to be displayed, and which are installed with the corresponding option, are also not returned. Extensions returned by this functions are not returned by ::XExtensionManger::getDeployedExtension ::XExtensionManger::getDeployedExtensions ::XExtensionManger::getAllExtensions ::XExtensionManger::getExtensionsWithSameIdentifier </td> </tr> <tr> <td class="imsum_left"><a href="#checkPrerequisitesAndEnable">checkPrerequisitesAndEnable</a></td> <td class="imsum_right">check if all prerequisites for the extension are fulfilled and activates it, if possible. </td> </tr> <tr> <td class="imsum_left"><a href="#isReadOnlyRepository">isReadOnlyRepository</a></td> <td class="imsum_right">determines if the current user has write access to the extensions folder of the repository. </td> </tr> </table> <a name="MethodsDetails"/><table border="1" width="100%" cellpadding="5" cellspacing="0" class="subtitle"> <tr> <td class="subtitle">Methods' Details</td> </tr> <tr> <td class="imdetail"><a name="getSupportedPackageTypes" class="membertitle">getSupportedPackageTypes</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="XPackageTypeInfo.html">XPackageTypeInfo</a> ></td> </tr> <tr> <td valign="top"><b>getSupportedPackageTypes</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets the supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </dd> <dt><b>Returns</b></dt> <dd>supported <a href="XPackageTypeInfo.html">XPackageTypeInfo</a>s. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="createAbortChannel" class="membertitle">createAbortChannel</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> </tr> <tr> <td valign="top"><b>createAbortChannel</b>();</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>creates a command channel to be used to asynchronously abort a command. </dd> <dt><b>Returns</b></dt> <dd>abort channel </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="addExtension" class="membertitle">addExtension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XPackage.html">XPackage</a></td> </tr> <tr> <td valign="top"><b>addExtension</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> url,</td> </tr> <tr> <td/><td valign="top">[in] sequence< ::com::sun::star::<a href="../beans/module-ix.html">beans</a>::<a href="../beans/NamedValue.html">NamedValue</a> ></td> <td valign="bottom"> properties,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>adds an extension. The properties argument is currently only used to suppress the license information for shared extensions. </dd> <dt><b>Parameter url</b></dt> <dd>package URL, must be UCB conform </dd> <dt><b>Parameter properties</b></dt> <dd>additional properties, for example, that the license is to be suppressed (if supported by the extension) </dd> <dt><b>Parameter repository</b></dt> <dd>the name of the repository </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the adding process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd>object representing the extension. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="removeExtension" class="membertitle">removeExtension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>removeExtension</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> identifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> fileName,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>removes an extension. </dd> <dt><b>Parameter identifier</b></dt> <dd>package identifier </dd> <dt><b>Parameter fileName</b></dt> <dd>package file name </dd> <dt><b>Parameter repository</b></dt> <dd>the name of the repository </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="enableExtension" class="membertitle">enableExtension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>enableExtension</b>(</td> <td valign="top">[in] <a href="XPackage.html">XPackage</a></td> <td valign="bottom"> extension,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>enable an extension. If the extension is not from the user repository then an IllegalArgumentException is thrown. </dd> <dt><b>Parameter extension</b></dt> <dd>the extension which is to be enabled. </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="disableExtension" class="membertitle">disableExtension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>disableExtension</b>(</td> <td valign="top">[in] <a href="XPackage.html">XPackage</a></td> <td valign="bottom"> extension,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>disable an extension. If the extension is not from the user repository then an IllegalArgumentException is thrown. </dd> <dt><b>Parameter extension</b></dt> <dd>the extension which is to be disabled </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDeployedExtensions" class="membertitle">getDeployedExtensions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="XPackage.html">XPackage</a> ></td> </tr> <tr> <td valign="top"><b>getDeployedExtensions</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets all currently installed extensions, including disabled user extensions. </dd> <dt><b>Parameter repository</b></dt> <dd>the repository from which the extensions are returned </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the removing process, or null </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd>all currently installed packages </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getDeployedExtension" class="membertitle">getDeployedExtension</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3"><a href="XPackage.html">XPackage</a></td> </tr> <tr> <td valign="top"><b>getDeployedExtension</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> identifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> fileName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets an installed extensions. </dd> <dt><b>Parameter repositroy</b></dt> <dd>the name of the repository </dd> <dt><b>Parameter identifier</b></dt> <dd>extension identifier </dd> <dt><b>Parameter fileName</b></dt> <dd>extension file name </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> <dt><b>Returns</b></dt> <dd><a href="XPackage.html">XPackage</a> object </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getExtensionsWithSameIdentifier" class="membertitle">getExtensionsWithSameIdentifier</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="XPackage.html">XPackage</a> ></td> </tr> <tr> <td valign="top"><b>getExtensionsWithSameIdentifier</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> identifier,</td> </tr> <tr> <td/><td valign="top">[in] string</td> <td valign="bottom"> fileName,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>gets all extensions with the same identifier from all repositories. The extension at the first position in the returned sequence represents the extension from the user repository. The next element is from the shared and the last one is from the bundled repository. If one repository does not contain this extension, then the respective element is a null reference. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getAllExtensions" class="membertitle">getAllExtensions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< sequence< <a href="XPackage.html">XPackage</a> > ></td> </tr> <tr> <td valign="top"><b>getAllExtensions</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns a sequence containing all installed extensions. The members of the returned sequence correspond to an extension with a particular extension identifier. The members are also sequences which contain as many elements as there are repositories. Those are ordered according to the priority of the repository. That is, the first member is the extension from the user repository, the second is from the shared repository and the last is from the bundled repository. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="reinstallDeployedExtensions" class="membertitle">reinstallDeployedExtensions</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>reinstallDeployedExtensions</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>Expert feature: erases the underlying registry cache and reinstalls all previously added extensions. Please keep in mind that all registration status get lost. </dd> <dd><p> Please use this in case of suspected cache inconsistencies only. </p> </dd> <dt><b>Parameter repositroy</b></dt> <dd>the name of the repository </dd> <dt><b>Parameter xAbortChannel</b></dt> <dd>abort channel to asynchronously abort the adding process </dd> <dt><b>Parameter xCmdEnv</b></dt> <dd>command environment for error and progress handling </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="synchronize" class="membertitle">synchronize</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>synchronize</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>synchronizes the extension database with the contents of the extensions folder of shared and bundled extensions. Added extensions will be added to the database and removed extensions will be removed from the database. The active extensions are determined. That is, shared or bundled extensions are not necessaryly registered (<a href="XPackage.html">XPackage</a>::<a href="XPackage.html#registerPackage">registerPackage</a>). </dd> <dt><b>Returns</b></dt> <dd>If true - then at least one extension was removed or added. Otherwise nothing was changed. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="synchronizeBundledPrereg" class="membertitle">synchronizeBundledPrereg</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">void</td> </tr> <tr> <td valign="top"><b>synchronizeBundledPrereg</b>(</td> <td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>synchronizes the special bundled_prereg repository, which is based on the bundled extensions and has its registration data folder at $BUNDLED_EXTENSIONS_PREREG (for example openoffice.org3/share/prereg). All bundled extensions are registered (<a href="XPackage.html">XPackage</a>::<a href="XPackage.html#registerPackage">registerPackage</a>). The active extensions are NOT determined, because this function only works with bundled extensions. This function is intended to be called during the installation of OOo. OOo will copy parts of the registration data folder to the user installation at the first startup. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="getExtensionsWithUnacceptedLicenses" class="membertitle">getExtensionsWithUnacceptedLicenses</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">sequence< <a href="XPackage.html">XPackage</a> ></td> </tr> <tr> <td valign="top"><b>getExtensionsWithUnacceptedLicenses</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> repository,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>returns all extensions which are currently not in use because the user did not accept the license. The function will not return any object for the user repository, because a user extension will not be kept in the user repository if its license is declined. Only extensions which are registered at start-up of OOo, that is, shared and bundled extensions, can be returned. Extensions which allow the license to be suppressed, that is, it does not need to be displayed, and which are installed with the corresponding option, are also not returned. Extensions returned by this functions are not returned by ::XExtensionManger::getDeployedExtension ::XExtensionManger::getDeployedExtensions ::XExtensionManger::getAllExtensions ::XExtensionManger::getExtensionsWithSameIdentifier </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="checkPrerequisitesAndEnable" class="membertitle">checkPrerequisitesAndEnable</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">long</td> </tr> <tr> <td valign="top"><b>checkPrerequisitesAndEnable</b>(</td> <td valign="top">[in] <a href="XPackage.html">XPackage</a></td> <td valign="bottom"> extension,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../task/module-ix.html">task</a>::<a href="../task/XAbortChannel.html">XAbortChannel</a></td> <td valign="bottom"> xAbortChannel,</td> </tr> <tr> <td/><td valign="top">[in] ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/XCommandEnvironment.html">XCommandEnvironment</a></td> <td valign="bottom"> xCmdEnv )</td> </tr> <tr> <td valign="top" align="right">raises( </td> <td valign="top" colspan="2"><a href="DeploymentException.html">DeploymentException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandFailedException.html">CommandFailedException</a>,<br> ::com::sun::star::<a href="../ucb/module-ix.html">ucb</a>::<a href="../ucb/CommandAbortedException.html">CommandAbortedException</a>,<br> ::com::sun::star::<a href="../lang/module-ix.html">lang</a>::<a href="../lang/IllegalArgumentException.html">IllegalArgumentException</a> );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>check if all prerequisites for the extension are fulfilled and activates it, if possible. </dd> </dl> </td> </tr> </table> </td> </tr> <tr> <td class="imdetail"><a name="isReadOnlyRepository" class="membertitle">isReadOnlyRepository</a><table border="0" width="96%" cellpadding="5" cellspacing="0" class="table-in-method" bgcolor="#ffffff" align="center"> <tr> <td><table class="table-in-method" border="0"> <tr> <td valign="top" colspan="3">boolean</td> </tr> <tr> <td valign="top"><b>isReadOnlyRepository</b>(</td> <td valign="top">[in] string</td> <td valign="bottom"> repository );</td> </tr> </table> <hr> <dl> <dt><b>Description</b></dt> <dd>determines if the current user has write access to the extensions folder of the repository. </dd> </dl> </td> </tr> </table> </td> </tr> </table> <a href="#_top_">Top of Page</a><hr size="3"><p class="copyright" align="center">Copyright © 2000, 2012 LibreOffice contributors and/or their affiliates. All rights reserved.</p><p class="copyright" align="center">LibreOffice was created by The Document Foundation, based on OpenOffice.org, which is Copyright 2000, 2010 Oracle and/or its affiliates.</p><p class="copyright" align="center">The Document Foundation acknowledges all community members, please find more info <a href="http://www.libreoffice.org/about-us/credits/" target="_blank">at our website</a>.<p> </p><p class="copyright" align="center"><a href="http://www.libreoffice.org/privacy" target="_blank">Privacy Policy</a> | <a href="http://www.libreoffice.org/imprint" target="_blank">Impressum (Legal Info)</a> | Copyright information: The source code of LibreOffice is licensed under the GNU Lesser General Public License (<a href="http://www.libreoffice.org/download/license/" target="_blank">LGPLv3</a>). "LibreOffice" and "The Document Foundation" are registered trademarks of their corresponding registered owners or are in actual use as trademarks in one or more countries. Their respective logos and icons are also subject to international copyright laws. Use thereof is explained in our <a href="http://wiki.documentfoundation.org/TradeMark_Policy" target="_blank">trademark policy</a>.</p> </div> <!-- id="adc-idlref" --> </body> </html>
