ExtensionUninstaller API Technical Documentation
ExtensionUninstall Object
This is the main object to use for uninstalling XUL applications.
Properties- Boolean doCustomInfo
- ExtUninstallLogger logger
- String packageUri
- Boolean removeContent
- Boolean removeLocale
- Boolean removeSkin
- Boolean test
- String type
- String version
- Constructor ExtensionUninstaller ( String packageUri )
- Boolean hasError ( )
- Boolean hasWarning ( )
- Boolean uninstall ( )
- void showLogDialog ( Boolean modal, Object openingFrom )
Property Details
Boolean doCustomInfo
If it's set to false, the API will not process #uninstallInfo and #uninstallFunc defined in the application's content.rdf. Refer to Optimizing Your XUL Application for Uninstall for more information.ExtUninstallLogger logger
Returns the logging object.String packageUri
Gets & Sets the extension's chrome uri.Boolean removeContent
If set to false, the API will not remove any of the main application elements from the chrome.rdf and overlays.Boolean removeLocale
If set to false, the API will not remove any locales.Boolean removeSkin
If set to false, the API will not remove any skins.Boolean test
Set to true if you only want to test the uninstall and see the generated logs without actually uninstalling the application.String type (READ ONLY)
Returns "ExtensionUninstall"String version (READ ONLY)
Returns the current vesion of the API as a String.Method Details
Contructor ExtensionUninstaller ( String packageUri )
Creates the object.- packageUri:
- The chrome URI of the application
Boolean hasError ( )
Returns true if there were any errors durring the uninstall.Boolean hasWarning ( )
Returns true if there were any warnings durring the uninstall.Boolean uninstall ( )
Uninstalls the application.Returns true on completion and false if there were errors.
void showLogDialog ( Boolean modal, Object openingFrom )
Opens the built in log tree dialog.- modal:
- If the dialog should be modal
- openingFrom:
- the document object to open the dialog (ie. self, window, opener, etc.)