Référence de l'API XPInstall:Objet InstallTrigger:Méthodes:install
Un article de MDC.
Sommaire |
[modifier] install
Installe un ou plusieurs fichiers xpi sur la machine locale.
[modifier] Méthode de
Objet InstallTrigger
[modifier] Syntaxe
int install(array XPIlist [, function callBackFunc ] )
[modifier] Paramètres
La méthode install a les paramètres suivants :
- XPIlist
- Un tableau de fichiers à installer (voir l'exemple ci-dessous).
callBackFunc- Une fonction de rappel invoquée lorsque l'installation est terminée (voir l'exemple ci-dessous).
[modifier] Retour
La méthode install retourne True si la fonction a été exécutée avec succès et False dans le cas contraire, mais ces valeurs ne sont pas toujours correctes quant au résultat de l'opération. Pour obtenir plus de détails sur l'état de l'installation, utilisez la fonction de rappel optionnelle et son paramètre d'état comme indiqué dans l'exemple ci-dessous.
[modifier] Description
Dans l'exemple ci-dessous, un constructeur d'objet JavaScript spécial est utilisé pour créer un objet qui peut être passé à la méthode install(). Le constructeur { } accepte un ensemble de paires étiquette/valeur séparées par des virgules. Pour les installations, ces paires sont, respectivement, le nom affiché dans la boîte de dialogue de confirmation XPInstall et le chemin du xpi.
Dans l'exemple ci-dessous, un unique objet d'installation est créé, mais il est possible d'utiliser cette approche pour créer des installations multiples à passer à une unique méthode install.
Comme avec la méthode startSoftwareUpdate, plus ancienne, les xpi installés avec cette méthode doivent avoir leurs propres fichiers install.js dans lesquels l'installation complète est définie. Contrairement à startSoftwareUpdate, install permet de procéder à des installations multiples avec le même déclencheur et fournit une meilleure expérience utilisateur pour les installations multiples.
[modifier] Exemple
function xpinstallCallback(url, status)
{
if (status == 0)
msg = "Test XPInstall : RÉUSSI\n";
else
msg = "Test XPInstall : ÉCHEC\n";
dump(msg);
alert(msg);
}
xpi={'XPInstall Pre-Checkin Test':'pre_checkin.xpi'};
InstallTrigger.install(xpi,xpinstallCallback);</pre>