registerChrome

 

registerChrome

Enregistre chrome dans le registre Chrome.

Méthode de

Objet Install

Syntaxe

int registerChrome(
  SWITCH,
  srcDir,
  xpiPath);

Paramètres

La méthode registerChrome a les paramètres suivants :

SWITCH
SWITCH est le switch chrome indiquant le type de fichier à enregistrer. SKIN est utilisé pour les thèmes, LOCALE est utilisé pour les paquetages de localisation. PACKAGE, un troisième type possible, est équivalent à SKIN AND/OR LOCALE et assure que tout dans le <tt>xpi</tt> sera enregistré. Une option finale pour ce paramètre est DELAYED_CHROME, qui enregistre le switch uniquement après un redémarrage du navigateur.

Il est possible de combiner les switches comme dans l'exemple ci-dessous.

srcDir
srcDir est un objet FileSpecObject représentant la destination source de l'installation. Les FileSpecObjects requis par cette fonction, sont créés en utilisant la méthode getFolder de l'objet Install.
xpiPath
xpiPath est le chemin, dans le <tt>xpi</tt>, où se trouve le fichier contents.rdf définissant le chrome. Par exemple, locale/myLocale/aim pointe vers le sous-répertoire locale/myLocale/aim du même fichier <tt>xpi</tt> que le script d'installation.

Retour

Un nombre entier correspondant à un code d'erreur. Pour la liste complète des valeurs possibles, voir Codes retournés. Dans certains cas, cette méthode peut retourner d'autres codes d'erreur. Il peut arriver d'obtenir une erreur d'enregistrement.

Description

Lorsque le troisième paramètre est omis (pointage vers un emplacement précis dans l'archive <tt>xpi</tt>), cette fonction est utilisée de façon dépréciée. Dans ce cas, registerChrome supporte l'ancien format des archives d'installation, dans lequel le fichier manifest.rdf était toujours situé au plus haut niveau de l'archive d'installation. registerChrome ne nécessite alors pas de chemin dans l'archive, comme il le requiert maintenant afin de localiser le format plus flexible du fichier contents.rdf des archives d'installation.

Il est possible de regarder dans le fichier installed-chrome.txt du répertoire chrome pour savoir où et comment la fonction registerChrome a enregistré le paquetage dans le registre chrome.

Exemple

Cet exemple suppose que votre archive xpi se trouve dans le dossier Plugins et que le fichier RDF est dans le sous-dossier resources de l'archive.

Vous devriez évitez cet appel (au cas où vous feriez un copier/coller depuis un ancien script d'installation) pour l'installation de plugin pour Firefox 2.x. Il n'est pas certain de ce que produira cet « enregistrement chrome ».

registerChrome(
  PACKAGE | DELAYED_CHROME,
  getFolder("Plugins"),
  "resources");

Interwiki Language Links

Étiquettes et contributeurs liés au document

 Contributeurs à cette page : teoli, Fredchat, Kyodev
 Dernière mise à jour par : teoli,