ApplicationUpdaterUI  - AS3

L’emplacement du fichier de configuration qui définit les valeurs de delay et updateURL. Cette propriété comporte également des paramètres permettant de déterminer si l’application affiche plusieurs boîtes de dialogue de confirmation lors du processus de mise à jour. Si cette propriété pointe vers un fichier non existant, l’appel de la méthode initialize() renvoie une exception Error.

Voici un exemple de fichier de configuration :

 <?xml version="1.0" encoding="utf-8"?> 
         <configuration xmlns="http://ns.adobe.com/air/framework/update/configuration/1.0" >
           <url>app:/server/update.xml</url>
           <delay>1</delay>
           <defaultUI>
              <dialog name="checkForUpdate" visible="true" />
               <dialog name="downloadUpdate" visible="false" />
               <dialog name="downloadProgress" visible="true" />
               <dialog name="installUpdate" visible="true" />    
           </defaultUI>
        </configuration>

Plutôt que de charger un fichier de configuration, vous pouvez utiliser le code ActionScript pour définir les propriétés suivantes de l’objet ApplicationUpdaterUI : delay, isCheckForUpdateVisible, isDownloadProgressVisible, isDownloadUpdateVisible, isFileUpdateVisible, isInstallUpdateVisible et updateURL.

Eléments de l’API associés

La version actuelle de l’application. Cette propriété est définie lors d’un appel de la méthode initialize(). Elle est définie sur la version du fichier descripteur d’application.

Intervalle entre les vérifications périodiques de nouvelles mises à jour, en jours.

Une valeur de 0 (valeur par défaut) indique que le minuteur n’est pas actif et que, par conséquent, aucune vérification périodique n’a lieu. Le délai peut être défini à l’aide de cette propriété ou via le fichier de configuration. Si les deux méthodes sont utilisées lors de la définition de la valeur, la valeur définie à l’aide de cette propriété est utilisée.

La valeur par défaut est 0.

Eléments de l’API associés

Active la visibilité des boîtes de dialogue Rechercher les mises à jour, Aucune mise à jour n’est disponible et Erreur de mise à jour. Lorsque cette propriété est définie sur true, le programme de mise à jour affiche ces boîtes de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

Active la visibilité de la boîte de dialogue de téléchargement de la mise à jour. Lorsque cette propriété est définie sur true, le programme de mise à jour affiche cette boîte de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

Active la visibilité de la boîte de dialogue de téléchargement de la mise à jour. Lorsque cette propriété est définie sur true, le programme de mise à jour affiche ces boîtes de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

Active la visibilité des boîtes de dialogue Fichier - Mise à jour, Fichier - Aucune mise à jour n’est disponible et Erreur de fichier. Lorsque cette propriété est définie sur true, le programme de mise à jour affiche ces boîtes de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

S’il s’agit de la première exécution après la réussite (true) ou l’échec (false) d’une mise à jour. Le programme de mise à jour définit cette valeur lors de l’appel de la méthode initialize(). Le développeur doit vérifier que la propriété isFirstRun est définie sur true au cas où il soit nécessaire de migrer des données d’une version à l’autre.

Eléments de l’API associés

Active la visibilité de la boîte de dialogue Installer la mise à jour. Lorsque cette propriété est définie sur true, le programme de mise à jour affiche cette boîte de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

Une fonction que le programme de mise à jour devrait utiliser pour effectuer des comparaisons. Par défaut, la structure de mise à jour effectue une comparaison de version afin de détecter si la version du site distant est plus récente que la version de l’application installée. Cependant, la comparaison par défaut ne correspond parfois pas au modèle de contrôle de version du développeur. Définissez cette propriété afin de fournir une nouvelle fonction qui effectue la comparaison.

La fonction de comparaison par défaut prend en charge les versions de type x.y.z, où x, y et z peuvent contenir des lettres et des chiffres. La fonction de comparaison par défaut reconnaît certaines conditions spéciales. Si la fonction de test détecte "alpha" , "beta" ou "rc" dans les chaînes de version, l’ordre est le suivant : alpha < beta < rc.

appUpdate.isNewerVersionFunction = customFn; 

function customFn (currentVersion:String, updateVersion:String):Boolean 
{
    return updateVersion > currentVersion;
}

Active la visibilité de la boîte de dialogue Erreur imprévue. Lorsque cette propriété est définie sur true, le programme de mise à jour de l’application affiche cette boîte de dialogue lors du processus de mise à jour. Cette propriété peut également être définie dans le fichier de configuration de la mise à jour. Une valeur définie à l’aide de cette propriété remplace le paramètre dans le fichier de configuration de la mise à jour.

Propriété Boolean, définie sur true si une mise à jour est en cours d’exécution, sur false dans le cas contraire.

Tableau définissant la chaîne de paramètres régionaux utilisée par l’interface utilisateur. En règle générale, seuls les développeurs JavaScript (HTML) utilisent cette propriété.

Les développeurs Flex peuvent utiliser ResourceManager pour gérer la chaîne de paramètres régionaux.

Par défaut, dans une application basée sur HTML, les langues sont triées en fonction des langues du tableau Capabilities.languages et des dix langues prises en charge par l’interface utilisateur. Si aucune correspondance n’est trouvée, la langue de l’interface utilisateur est l’anglais.

Cet exemple JavaScript utilise la structure de localisation HTML d’AIR incluse dans le kit de développement AIR. Il trie les langues en fonction de la liste des langues, puis définit l’anglais comme langue par défaut :

 appUpdater.addResources("ro_RO", {titleCheck: "Titlu", msgCheck: "Mesaj", btnCheck: "Buton"});
        appUpdater.addResources("hu", {titleCheck: "Cím", msgCheck: "Üzenet"}); 
        var languages = ["ro", "hu"];
        languages = languages.concat(air.Capabilities.languages);
        var sortedLanguages = air.Localizer.sortLanguagesByPreference(languages, air.Capabilities.language, "en-US");  
        sortedLanguages.push("en-US");
        appUpdater.localeChain = sortedLanguages;

Eléments de l’API associés

L’emplacement précédent du répertoire de stockage de l’application, si celui-ci a changé après une mise à jour. L’emplacement du répertoire de stockage de l’application change après une mise à niveau avec une migration de certificats. Si aucun certificat n’est migré, le répertoire de stockage de l’application ne change pas lorsque l’utilisateur met l’application à jour. et cette propriété est définie sur null. Cette propriété est définie lors d’un appel de la méthode initialize().

Un développeur peut signer une nouvelle version d’une application AIR à l’aide d’un nouveau certificat s’il utilise l’option -migrate lors de la mise en package du fichier AIR avec l’outil ADT. Si une nouvelle version d’une application AIR utilise un nouveau certificat de signature, le répertoire de stockage local de l’application change lorsque l’utilisateur installe la nouvelle version. Utilisez cette propriété pour transférer les données de l’ancien répertoire de stockage de l’application vers le nouveau répertoire de stockage de l’application (File.applicationStorageDirectory). Pour plus d’informations, voir la section « Signature d’un fichier AIR pour modifier le certificat de l’application » dans le chapitre « Création d’une application AIR à l’aide des outils de la ligne de commande » du guide de développeur d’Adobe AIR.

La version précédente de l’application. Cette propriété est définie lors d’un appel de la méthode initialize(). Renvoie la version précédente de l’application avant la mise à niveau (définie uniquement si la propriété isfirstRun est true) ; dans le cas contraire, elle est définie sur null.

Le contenu du fichier descripteur de mise à jour téléchargé depuis l’URL de mise à jour. Cette propriété est non-nulle uniquement après que l’objet updater distribue un événement updateStatus.

L’emplacement du fichier descripteur de mise à jour. Tous les emplacements valides pour un chemin URLRequest sont acceptés. Il s’agit du seul paramètre obligatoire requis pas le programme de mise à jour. Vous pouvez définir l’URL de mise à jour via la propriété ou via le fichier de configuration. Lorsque la valeur est définie à l’aide des deux méthodes, le programme de mise à jour utilise la valeur définie avec cette propriété.

Eléments de l’API associés

S’il existait une mise à jour reportée, que son installation ait échoué (true) ou non (false). Le programme de mise à jour définit cette propriété lors d’un appel de la méthode initialize(). Utilisez les propriétés wasPendingUpdate et isFirstRun pour vérifier si l’installation d’une mise à jour a échoué (auquel cas, wasPendingUpdate est définie sur true et isFirstRun sur false).

Eléments de l’API associés

Fonction du constructeur.

Ajoute de façon dynamique un nouveau regroupement de ressources pour la langue spécifiée. Les développeurs JavaScript utilisent cette méthode pour ajouter de façon dynamique une nouvelle langue aux boîtes de dialogue que l’IU du programme de mise à jour de l’application affiche (les développeurs Flex peuvent directement ajouter une nouvelle langue au regroupement de ressources « ApplicationUpdaterDialogs »).

Paramètres

Eléments de l’API associés

Annule le processus de mise à jour. L’appel de cette méthode annule tous les téléchargements en attente, supprime tous les fichiers téléchargés incomplets et redémarre le minuteur de vérification périodique.

Vous pouvez à tout moment annuler le processus de mise à jour, sauf lorsque l’état de la machine est « uninitialized » ou « initializing ». Cette méthode est sans effet lorsqu’elle est appelée dans l’état « uninitialized » ou « initializing ».

Démarre le processus de mise à jour. L’appel de cette méthode n’arrête pas le minuteur périodique. Toutefois, la méthode détecte qu’un processus de mise à jour est en cours d’exécution et ignore l’itération actuelle.

Cette méthode n’est exécutée que lorsque l’état actuel est « Ready ».

Lorsque cette méthode est exécutée, il est possible que l’objet updater distribue l’événement suivant :

Initialise le programme de mise à jour. L’appel de cette méthode a les effets suivants :

1. Il initialise la structure d’application de mise à jour, et installe de manière silencieuse et synchrone les mises à jour en attente. Vous devez appeler cette méthode au démarrage de l’application, car elle risque de redémarrer l’application.

2. Il vérifie si une mise à jour a été reportée et, le cas échéant, procède à son installation.

3. Si une erreur s’est produite lors d’une mise à jour antérieure, il supprime le fichier de mise à jour et les informations de version de la zone de stockage.

4. Si le minuteur périodique a expiré, il lance le processus de mise à jour ; dans le cas contraire, il démarre le minuteur périodique. Néanmoins, lorsqu’une application est testée à l’aide de l’application de débogage du lanceur AIR (ADL), une exception IllegalOperationError est renvoyée lors d’une tentative de mise à jour de l’application.

Lance le processus de mise à jour à l’aide d’un fichier AIR local.

L’appel de cette méthode est sans effet si un processus de mise à jour est en cours d’exécution (si l’état n’est pas "Downloaded").

Cette fonction est utile pour une application dont l’élément customUpdateUI est défini sur true dans le fichier descripteur d’application.

Lorsqu’une application est testée à l’aide de l’application de débogage du lanceur AIR (ADL), l’appel de cette méthode renvoie une exception IllegalOperationError.

Paramètres

Distribué juste avant l’installation de la mise à jour, après l’appel de la méthode installUpdate(). Il est parfois utile d’éviter l’installation de la mise à jour ; l’utilisateur risque en effet de perdre tous les travaux en cours lorsque le moteur d’exécution quitte l’application afin d’installer la mise à jour.

L’appel de la méthode preventDefault() de cet événement repousse l’installation jusqu’au prochain redémarrage. Si vous appelez la méthode preventDefault(), aucun autre processus de mise à jour ne peut démarrer pendant la session active (via un appel de la méthode installUpdate() ou suite à une vérification périodique).

Les propriétés de cet événement sont les suivantes :

Distribué avant le début du processus de mise à jour, juste avant que le programme de mise à jour ne tente de télécharger le fichier descripteur de mise à jour. Le programme de mise à jour peut distribuer cet événement suite à un appel direct de la méthode checkNow() ou suite à l’expiration du minuteur de vérification périodique.

Les propriétés de cet événement sont les suivantes :

Distribué une fois le téléchargement du fichier de mise à jour terminé.

Les propriétés de cet événement sont les suivantes :

Distribué lorsqu’une erreur se produit lors de la connexion ou du téléchargement du fichier de mise à jour. Distribué également en cas d’états HTTP non valides (par exemple, Erreur 404 - Fichier introuvable).

Lorsque cet événement est distribué, le minuteur périodique est automatiquement redémarré (si le paramètre delay est supérieur à 0).

La propriété errorID d’un objet DownloadErrorEvent est un entier qui définit les informations relatives à l’erreur (consultez le tableau ci-dessous). Il est possible qu’une propriété subErrorID supplémentaire contienne davantage d’informations sur l’erreur.

Distribué après un appel de la méthode downloadUpdate() et une fois la connexion au serveur établie. Lors de l’utilisation de la bibliothèque ApplicationUpdater, le gestionnaire d’événement de cet événement peut afficher une barre de progression afin d’indiquer à l’utilisateur l’état du téléchargement.

Les propriétés de cet événement sont les suivantes :

Distribué lorsqu’une erreur s’est produite lors de l’initialisation ou la mise à jour (si une erreur inattendue est survenue).

Les propriétés de cet événement sont les suivantes :

Distribué lorsqu’une erreur se produit lors de la validation du fichier transmis en tant que paramètre airFile dans un appel de la méthode installFromAIRFile().

Distribué après que le programme de mise à jour a correctement validé le fichier lors de l’appel de la méthode installFromAIRFile().

Les propriétés de cet événement sont les suivantes :

Distribué une fois l’initialisation terminée.

Les propriétés en lecture seule de cet événement sont les suivantes :

• isFirstRun (Boolean) Définie sur true s’il s’agit de la première exécution après une mise à jour réussie, sur false dans le cas contraire.

• previousVersion (String) La version précédente de l’application avant la mise à niveau (définie uniquement si isfirstRun est true).

• currentVersion (String) La version du fichier descripteur d’application de la version actuellement installée.

Les propriétés de cet événement sont les suivantes :

Distribué lors du téléchargement du fichier de mise à jour.

Les propriétés de cet événement sont les suivantes :

Distribué lorsqu’une erreur se produit lors d’une tentative de téléchargement ou d’analyse du fichier descripteur de mise à jour.

Lorsque le programme de mise à jour distribue cet événement, le minuteur périodique est automatiquement redémarré (si le paramètre delay est supérieur à 0). L’application doit envisager le masquage de toutes les boîtes de dialogue d’erreur lorsque le programme de mise à jour distribue un événement checkForUpdate.

Distribué une fois que le programme de mise à jour a correctement téléchargé et interprété le fichier descripteur de mise à jour.

Les propriétés de cet événement sont les suivantes :