XPInstall API reference

Parts of this page show the use of the XPInstall API. The majority of this API is now deprecated and as of Gecko 1.9 no longer available. Extension, Theme, and plug-in developers must switch away from install.js based packages to the new packaging scheme with an install.rdf manifest. In particular plugin developers should see how to package a plugin as an extension.

Objects

Install

Properties
Methods
addDirectory
addFile
alert
cancelInstall
confirm
deleteRegisteredFile
execute
gestalt
getComponentFolder
getFolder
getLastError
getWinProfile
getWinRegistry
initInstall
loadResources
logComment
patch
performInstall
refreshPlugins
registerChrome
resetError
setPackageFolder

InstallTrigger

No properties
Methods
compareVersion
enabled
getVersion
install
installChrome
startSoftwareUpdate

InstallVersion

Properties
Methods
compareTo
init
toString

File

No properties
Methods
copy
dirCreate
dirGetParent
dirRemove
dirRename
diskSpaceAvailable
execute
exists
isDirectory
isFile
macAlias
modDate
modDateChanged
move
remove
rename
size
windowsGetShortName
windowsRegisterServer
windowsShortcut

WinProfile

No properties
Methods
getString
writeString

WinReg

No properties
Methods
createKey
deleteKey
deleteValue
enumKeys
enumValueNames
getValue
getValueNumber
getValueString
isKeyWritable
keyExists
setRootKey
setValue
setValueNumber
setValueString
valueExists
WinRegValue constructor

Other Information

Return Codes

See complete list

Examples

Trigger Scripts and Install Scripts
Code Samples
File.macAlias
File.windowsShortcut
Install.addDirectory
Install.addFile
InstallTrigger.installChrome
InstallTrigger.startSoftwareUpdate
Windows Install