Ce fichier de configuration de la mise à jour est un fichier XML. Il peut contenir les éléments suivants :
-
updateURL
: chaîne représentant l’emplacement du descripteur de la mise à jour sur le serveur distant. Tout emplacement URLRequest valide est autorisé. Vous devez définir la propriété
updateURL
, par l’intermédiaire du fichier de configuration ou du script (voir
Définition des fichiers descripteurs de mise à jour et ajout du fichier AIR dans le serveur Web
). Vous devez définir cette propriété avant d’utiliser l’objet updater (avant d’appeler la méthode
initialize()
de l’objet updater, décrite à la section
Initialisation de la structure de mise à jour
).
-
delay
: nombre représentant un intervalle de jours donné (des valeurs comme
0.25
sont autorisées) correspondant à la fréquence de vérification de la présence de mises à jour. Une valeur 0 (définie par défaut) spécifie que l’objet updater ne vérifie pas automatiquement la présence de mise à jour.
Le fichier de configuration d’ApplicationUpdaterUI peut contenir l’élément suivant en plus des éléments
updateURL
et
delay
:
-
defaultUI
: liste des éléments
dialog
. Chaque élément
dialog
possède un attribut
name
correspondant à une boîte de dialogue de l’interface utilisateur. Chaque élément
dialog
possède un attribut
visible
qui spécifie si la boîte de dialogue est visible. La valeur par défaut est
true
. Les valeurs possibles de l’attribut
name
sont les suivantes :
-
"checkForUpdate"
: correspondant aux boîtes de dialogue Rechercher une mise à jour, Aucune mise à jour et Erreur de mise à jour.
-
"downloadUpdate"
: correspondant à la boîte de dialogue Télécharger la mise à jour.
-
"downloadProgress"
: correspondant aux boîtes de dialogue Progression du téléchargement et Erreur de téléchargement.
-
"installUpdate"
: correspondant à la boîte de dialogue Installer la mise à jour.
-
"fileUpdate"
: correspondant aux boîtes de dialogue Mise à jour des fichiers, Aucune mise à jour de fichiers et Erreur de fichier.
-
"unexpectedError"
: correspondant à la boîte de dialogue Erreur imprévue.
Lorsque l’attribut est défini sur
false
, la boîte de dialogue correspondante ne s’affiche pas dans le cadre de la procédure de mise à jour.
Voici un exemple de fichier de configuration pour la structure ApplicationUpdater :
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0">
<url>http://example.com/updates/update.xml</url>
<delay>1</delay>
</configuration>
Voici un exemple de fichier de configuration pour la structure ApplicationUpdaterUI, comprenant une définition de l’élément
defaultUI
:
<?xml version="1.0" encoding="utf-8"?>
<configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0">
<url>http://example.com/updates/update.xml</url>
<delay>1</delay>
<defaultUI>
<dialog name="checkForUpdate" visible="false" />
<dialog name="downloadUpdate" visible="false" />
<dialog name="downloadProgress" visible="false" />
</defaultUI>
</configuration>
Pointez la propriété
configurationFile
vers l’emplacement du fichier :
Exemple ActionScript :
appUpdater.configurationFile = new File("app:/cfg/updateConfig.xml");
Exemple JavaScript :
appUpdater.configurationFile = new air.File("app:/cfg/updateConfig.xml");
Le répertoire templates de la structure de mise à jour comprend un exemple de fichier de configuration, config-template.xml.