Public Types | Public Member Functions | Public Attributes

amIInstallTrigger Interface Reference

The interface for the InstallTrigger object available to all websites. More...

import "amIInstallTrigger.idl";

List of all members.

Public Types

enum  { SKIN = 1U }
 

Retained for backwards compatibility.

More...
enum  { LOCALE = 2U }
enum  { CONTENT = 4U }
enum  { PACKAGE = 7U }

Public Member Functions

NS_DEPRECATED NS_SCRIPTABLE
NS_IMETHOD 
UpdateEnabled (PRBool *_retval NS_OUTPARAM)=0
 Tests if installation is enabled.
NS_SCRIPTABLE NS_IMETHOD Enabled (PRBool *_retval NS_OUTPARAM)=0
 Tests if installation is enabled.
NS_SCRIPTABLE NS_IMETHOD Install (nsIVariant *aArgs, amIInstallCallback *aCallback, PRBool *_retval NS_OUTPARAM)=0
 Starts a new installation of a set of add-ons.
NS_SCRIPTABLE NS_IMETHOD InstallChrome (PRUint32 aType, const nsAString &aUrl, const nsAString &aSkin, PRBool *_retval NS_OUTPARAM)=0
 Starts installing a new add-on.
NS_DEPRECATED NS_SCRIPTABLE
NS_IMETHOD 
StartSoftwareUpdate (const nsAString &aUrl, PRInt32 aFlags, PRBool *_retval NS_OUTPARAM)=0
 Starts installing a new add-on.
boolean updateEnabled ()
 Tests if installation is enabled.
boolean enabled ()
 Tests if installation is enabled.
boolean install (in nsIVariant aArgs,[optional] in amIInstallCallback aCallback)
 Starts a new installation of a set of add-ons.
boolean installChrome (in PRUint32 aType, in AString aUrl, in AString aSkin)
 Starts installing a new add-on.
boolean startSoftwareUpdate (in AString aUrl,[optional] in PRInt32 aFlags)
 Starts installing a new add-on.

Public Attributes

const PRUint32 SKIN = 1
 Retained for backwards compatibility.
const PRUint32 LOCALE = 2
const PRUint32 CONTENT = 4
const PRUint32 PACKAGE = 7

Detailed Description

The interface for the InstallTrigger object available to all websites.


Member Enumeration Documentation

anonymous enum

Retained for backwards compatibility.

Enumerator:
SKIN 
anonymous enum
Enumerator:
LOCALE 
anonymous enum
Enumerator:
CONTENT 
anonymous enum
Enumerator:
PACKAGE 

Member Function Documentation

NS_SCRIPTABLE NS_IMETHOD amIInstallTrigger::Enabled ( PRBool *_retval  NS_OUTPARAM  )  [pure virtual]

Tests if installation is enabled.

boolean amIInstallTrigger::enabled (  ) 

Tests if installation is enabled.

boolean amIInstallTrigger::install ( in nsIVariant  aArgs,
[optional] in amIInstallCallback  aCallback 
)

Starts a new installation of a set of add-ons.

Parameters:
aArgs The add-ons to install. This should be a JS object, each property is the name of an add-on to be installed. The value of the property should either be a string URL, or an object with the following properties: * URL for the add-on's URL * IconURL for an icon for the add-on * Hash for a hash of the add-on
aCallback A callback to call as each installation succeeds or fails
Returns:
true if the installations were successfully started
NS_SCRIPTABLE NS_IMETHOD amIInstallTrigger::Install ( nsIVariant aArgs,
amIInstallCallback aCallback,
PRBool *_retval  NS_OUTPARAM 
) [pure virtual]

Starts a new installation of a set of add-ons.

Parameters:
aArgs The add-ons to install. This should be a JS object, each property is the name of an add-on to be installed. The value of the property should either be a string URL, or an object with the following properties: * URL for the add-on's URL * IconURL for an icon for the add-on * Hash for a hash of the add-on
aCallback A callback to call as each installation succeeds or fails
Returns:
true if the installations were successfully started
boolean amIInstallTrigger::installChrome ( in PRUint32  aType,
in AString  aUrl,
in AString  aSkin 
)

Starts installing a new add-on.

This method is deprecated, please use "install" in the future.

Parameters:
aType Unused, retained for backwards compatibility
aUrl The URL of the add-on
aSkin Unused, retained for backwards compatibility
Returns:
true if the installation was successfully started
NS_SCRIPTABLE NS_IMETHOD amIInstallTrigger::InstallChrome ( PRUint32  aType,
const nsAString aUrl,
const nsAString aSkin,
PRBool *_retval  NS_OUTPARAM 
) [pure virtual]

Starts installing a new add-on.

This method is deprecated, please use "install" in the future.

Parameters:
aType Unused, retained for backwards compatibility
aUrl The URL of the add-on
aSkin Unused, retained for backwards compatibility
Returns:
true if the installation was successfully started
NS_DEPRECATED NS_SCRIPTABLE NS_IMETHOD amIInstallTrigger::StartSoftwareUpdate ( const nsAString aUrl,
PRInt32  aFlags,
PRBool *_retval  NS_OUTPARAM 
) [pure virtual]

Starts installing a new add-on.

Deprecated:
use "install" in the future.
Parameters:
aUrl The URL of the add-on
aFlags Unused, retained for backwards compatibility
Returns:
true if the installation was successfully started
boolean amIInstallTrigger::startSoftwareUpdate ( in AString  aUrl,
[optional] in PRInt32  aFlags 
)

Starts installing a new add-on.

Deprecated:
use "install" in the future.
Parameters:
aUrl The URL of the add-on
aFlags Unused, retained for backwards compatibility
Returns:
true if the installation was successfully started
NS_DEPRECATED NS_SCRIPTABLE NS_IMETHOD amIInstallTrigger::UpdateEnabled ( PRBool *_retval  NS_OUTPARAM  )  [pure virtual]

Tests if installation is enabled.

Deprecated:
Use "enabled" in the future.
boolean amIInstallTrigger::updateEnabled (  ) 

Tests if installation is enabled.

Deprecated:
Use "enabled" in the future.

Member Data Documentation

const PRUint32 amIInstallTrigger::CONTENT = 4
const PRUint32 amIInstallTrigger::LOCALE = 2
const PRUint32 amIInstallTrigger::PACKAGE = 7
const PRUint32 amIInstallTrigger::SKIN = 1

Retained for backwards compatibility.


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