| Package | air.update |
| Classe | public class ApplicationUpdaterUI |
| Héritage | ApplicationUpdaterUI  EventDispatcher Object |
| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Cette classe est incluse dans le fichier applicationupdater_ui.swc compris dans le kit de développement d’Adobe AIR. Le fichier applicationupdater_ui.swc se trouve dans le répertoire frameworks/libs/air du kit de développement d’AIR. La version qui se trouve dans le répertoire frameworks/libs/air du kit de développement d’AIR 2 est destinée au développement de Flex 4. Si vous utilisez Flex 3, utilisez la version qui se trouve dans le sous-répertoire frameworks/libs/air/flex3.
Adobe® Flex™ Builder™ charge cette classe automatiquement lors de la création d’un projet pour Adobe AIR. Vous devez inclure le fichier SWC lors de la compilation de l’application au moyen du kit de développement d’Adobe® Flex™.
La gestion des mises à jour d’applications peut être compliquée. La structure de mise à jour AIR fournit des API pour aider les développeurs à créer des fonctions de mise à jour puissantes dans les applications AIR. La structure de mise à jour AIR aide les développeurs à effectuer les opérations suivantes :
-
Vérifier périodiquement la présence de mises à jour en fonction d’un intervalle ou selon les besoins de l’utilisateur ;
-
Télécharger les fichiers AIR (mises à jour) à partir d’une source Web ;
-
Avertir l’utilisateur lors de la première exécution de la version récemment installée ;
-
Confirmer que l’utilisateur souhaite rechercher des mises à jour ;
-
Donner à l’utilisateur des informations sur la version de la nouvelle mise à jour ;
-
Informer l’utilisateur de la progression du téléchargement et afficher les informations d’erreur.
La structure d’application de mise à jour AIR vous permet de stocker des informations sur la version de mise à jour d’une application AIR dans des fichiers de configuration XML simples. Le paramétrage des fichiers de configuration et l’inclusion de code de base permettent à l’utilisateur final de bénéficier d’une fonction de mise à jour optimisée dans la plupart des applications.
La classe AIRUpdateUI implémente une interface utilisateur par défaut que votre application peut utiliser. Elle donne à l’utilisateur des informations et des options de base relatives aux mises à jour de l’application.
Le processus de mise à jour passe par plusieurs états :
| Etat | Description |
|---|---|
| Uninitialized | Le programme de mise à jour n’a pas été initialisé. |
| Initializing | Le programme de mise à jour est en cours d’initialisation. |
| Ready | Le programme de mise à jour a été initialisé. |
| Before checking | Le programme de mise à jour n’a pas encore recherché le fichier descripteur de mise à jour. |
| Checking | Le programme de mise à jour recherche actuellement le fichier descripteur de mise à jour. |
| Available | Le fichier descripteur de mise à jour est disponible. |
| Downloading | Le programme de mise à jour télécharge actuellement le fichier AIR. |
| Downloaded | Le programme de mise à jour a téléchargé le fichier AIR. |
| Installing | Le programme de mise à jour installe actuellement le fichier AIR. |
| Pending install | Le programme de mise à jour a été initialisé et des mises à jour sont en attente. |
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.
La structure de mise à jour AIR est uniquement prise en charge dans le profil de bureau. Elle n’est prise en charge ni pour les applications de bureau étendu (applications installées avec un programme d’installation natif) ni sur le profil mobile (applications iPhone écrites avec ActionScript 3.0). Vérifiez la propriété Updater.isSupported à l’exécution pour savoir si la structure de mise à jour est prise en charge.
Pour plus de détails sur l'utilisation de la structure de mise à jour AIR, consulter la section « Mise à jour des applications AIR » du document Création d'applications Adobe AIR.
Eléments de l’API associés
Masquer les propriétés publiques héritées
Afficher les propriétés publiques héritées| Propriété | Défini par | ||
|---|---|---|---|
| configurationFile : File
L’emplacement du fichier de configuration qui définit les valeurs des propriétés delay et updateURL. | ApplicationUpdaterUI | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| currentVersion : String [lecture seule]
La version actuelle de l’application. | ApplicationUpdaterUI | ||
| delay : Number
Intervalle entre les vérifications périodiques de nouvelles mises à jour, en jours. | ApplicationUpdaterUI | ||
| isCheckForUpdateVisible : Boolean
Active la visibilité des boîtes de dialogue Rechercher les mises à jour, Aucune mise à jour n’est disponible et Erreur de mise à jour. | ApplicationUpdaterUI | ||
| isDownloadProgressVisible : Boolean
Active la visibilité de la boîte de dialogue de téléchargement de la mise à jour. | ApplicationUpdaterUI | ||
| isDownloadUpdateVisible : Boolean
Active la visibilité de la boîte de dialogue de téléchargement de la mise à jour. | ApplicationUpdaterUI | ||
| isFileUpdateVisible : Boolean
Active la visibilité des boîtes de dialogue Fichier - Mise à jour, Fichier - Aucune mise à jour n’est disponible et Erreur de fichier. | ApplicationUpdaterUI | ||
| isFirstRun : Boolean [lecture seule]
S’il s’agit de la première exécution après la réussite (true) ou l’échec (false) d’une mise à jour. | ApplicationUpdaterUI | ||
| isInstallUpdateVisible : Boolean
Active la visibilité de la boîte de dialogue Installer la mise à jour. | ApplicationUpdaterUI | ||
| isNewerVersionFunction : Function
Une fonction que le programme de mise à jour devrait utiliser pour effectuer des comparaisons. | ApplicationUpdaterUI | ||
| isUnexpectedErrorVisible : Boolean
Active la visibilité de la boîte de dialogue Erreur imprévue. | ApplicationUpdaterUI | ||
| isUpdateInProgress : Boolean [lecture seule]
Propriété Boolean, définie sur true si une mise à jour est en cours d’exécution, sur false dans le cas contraire. | ApplicationUpdaterUI | ||
| localeChain : Array
Tableau définissant la chaîne de paramètres régionaux utilisée par l’interface utilisateur. | ApplicationUpdaterUI | ||
| previousApplicationStorageDirectory : File [lecture seule]
L’emplacement précédent du répertoire de stockage de l’application, si celui-ci a changé après une mise à jour. | ApplicationUpdaterUI | ||
| previousVersion : String [lecture seule]
La version précédente de l’application. | ApplicationUpdaterUI | ||
| updateDescriptor : XML [lecture seule]
Le contenu du fichier descripteur de mise à jour téléchargé depuis l’URL de mise à jour. | ApplicationUpdaterUI | ||
| updateURL : String
L’emplacement du fichier descripteur de mise à jour. | ApplicationUpdaterUI | ||
| wasPendingUpdate : Boolean [lecture seule]
S’il existait une mise à jour reportée, que son installation ait échoué (true) ou non (false). | ApplicationUpdaterUI | ||
| Méthode | Défini par | ||
|---|---|---|---|
Fonction du constructeur. | ApplicationUpdaterUI | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
Ajoute de façon dynamique un nouveau regroupement de ressources pour la langue spécifiée. | ApplicationUpdaterUI | ||
Annule le processus de mise à jour. | ApplicationUpdaterUI | ||
Démarre le processus de mise à jour. | ApplicationUpdaterUI | ||
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
Initialise le programme de mise à jour. | ApplicationUpdaterUI | ||
Lance le processus de mise à jour à l’aide d’un fichier AIR local. | ApplicationUpdaterUI | ||
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
| Evénement | Synthèse | Défini par | ||
|---|---|---|---|---|
| [Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active. | EventDispatcher | ||
| Distribué juste avant l’installation de la mise à jour, après l’appel de la méthode installUpdate(). | ApplicationUpdaterUI | |||
| 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. | ApplicationUpdaterUI | |||
| [Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive. | EventDispatcher | ||
| Distribué une fois le téléchargement du fichier de mise à jour terminé. | ApplicationUpdaterUI | |||
| Distribué lorsqu’une erreur se produit lors de la connexion ou du téléchargement du fichier de mise à jour. | ApplicationUpdaterUI | |||
| Distribué après un appel de la méthode downloadUpdate() et une fois la connexion au serveur établie. | ApplicationUpdaterUI | |||
| Distribué lorsqu’une erreur s’est produite lors de l’initialisation ou la mise à jour (si une erreur inattendue est survenue). | ApplicationUpdaterUI | |||
| 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(). | ApplicationUpdaterUI | |||
| Distribué après que le programme de mise à jour a correctement validé le fichier lors de l’appel de la méthode installFromAIRFile(). | ApplicationUpdaterUI | |||
| Distribué une fois l’initialisation terminée. | ApplicationUpdaterUI | |||
| Distribué lors du téléchargement du fichier de mise à jour. | ApplicationUpdaterUI | |||
| Distribué lorsqu’une erreur se produit lors d’une tentative de téléchargement ou d’analyse du fichier descripteur de mise à jour. | ApplicationUpdaterUI | |||
| Distribué une fois que le programme de mise à jour a correctement téléchargé et interprété le fichier descripteur de mise à jour. | ApplicationUpdaterUI | |||
configurationFile | propriété |
configurationFile:File| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get configurationFile():File public function set configurationFile(value:File):voidEléments de l’API associés
currentVersion | propriété |
currentVersion:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get currentVersion():String delay | propriété |
delay:Number| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get delay():Number public function set delay(value:Number):voidEléments de l’API associés
isCheckForUpdateVisible | propriété |
isCheckForUpdateVisible:Boolean| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isCheckForUpdateVisible():Boolean public function set isCheckForUpdateVisible(value:Boolean):void isDownloadProgressVisible | propriété |
isDownloadProgressVisible:Boolean| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isDownloadProgressVisible():Boolean public function set isDownloadProgressVisible(value:Boolean):void isDownloadUpdateVisible | propriété |
isDownloadUpdateVisible:Boolean| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isDownloadUpdateVisible():Boolean public function set isDownloadUpdateVisible(value:Boolean):void isFileUpdateVisible | propriété |
isFileUpdateVisible:Boolean| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isFileUpdateVisible():Boolean public function set isFileUpdateVisible(value:Boolean):void isFirstRun | propriété |
isFirstRun:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isFirstRun():BooleanEléments de l’API associés
isInstallUpdateVisible | propriété |
isInstallUpdateVisible:Boolean| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isInstallUpdateVisible():Boolean public function set isInstallUpdateVisible(value:Boolean):void isNewerVersionFunction | propriété |
isNewerVersionFunction:Function| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isNewerVersionFunction():Function public function set isNewerVersionFunction(value:Function):voidExemple ( Comment utiliser cet exemple )
customFn, pour l’objet updater appUpdate. La fonction d’exemple est délibérément simple. Votre fonction personnalisée doit renvoyer une valeur booléenne en fonction des règles de votre modèle de contrôle de version.
appUpdate.isNewerVersionFunction = customFn;
function customFn (currentVersion:String, updateVersion:String):Boolean
{
return updateVersion > currentVersion;
}
isUnexpectedErrorVisible | propriété |
isUnexpectedErrorVisible:Boolean| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get isUnexpectedErrorVisible():Boolean public function set isUnexpectedErrorVisible(value:Boolean):void isUpdateInProgress | propriété |
localeChain | propriété |
localeChain:Array| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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;Implémentation
public function get localeChain():Array public function set localeChain(value:Array):voidEléments de l’API associés
previousApplicationStorageDirectory | propriété |
previousApplicationStorageDirectory:File [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get previousApplicationStorageDirectory():File previousVersion | propriété |
previousVersion:String [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get previousVersion():String updateDescriptor | propriété |
updateDescriptor:XML [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
Implémentation
public function get updateDescriptor():XML updateURL | propriété |
updateURL:String| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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é.
Implémentation
public function get updateURL():String public function set updateURL(value:String):voidEléments de l’API associés
wasPendingUpdate | propriété |
wasPendingUpdate:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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).
Implémentation
public function get wasPendingUpdate():BooleanEléments de l’API associés
ApplicationUpdaterUI | () | Constructeur |
public function ApplicationUpdaterUI()| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Fonction du constructeur.
addResources | () | méthode |
public function addResources(lang:String, res:Object):void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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
lang:String — Le code de langue (par exemple, "ro" pour le roumain).
| |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
res:Object — L’objet contient les clés et les valeurs pour la translation. Les clés sont celles du fichier des propriétés de la langue. Le tableau suivant répertorie les clés disponibles (noms de propriété).
|
Eléments de l’API associés
cancelUpdate | () | méthode |
public function cancelUpdate():void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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 ».
checkNow | () | méthode |
public function checkNow():void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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 :
Evénements
checkForUpdate: — Distribué juste avant le début du processus de mise à jour.
|
initialize | () | méthode |
public function initialize():void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Initialise le programme de mise à jour. L’appel de cette méthode a les effets suivants :
-
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.
-
Il vérifie si une mise à jour a été reportée et, le cas échéant, procède à son installation.
-
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.
-
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.
Evénements
initialized: — L’initialisation est terminée.
| |
error: — Une erreur s’est produite lors de l’initialisation.
|
installFromAIRFile | () | méthode |
public function installFromAIRFile(file:File):void| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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
file:File — Le fichier AIR local à installer.
|
Evénements
fileUpdateStatus: — Distribué après que le programme de mise à jour valide correctement le fichier AIR.
| |
updateError: — Distribué lorsqu’une erreur se produit lors d’une tentative d’analyse du fichier descripteur de mise à jour.
|
beforeInstall | Evénement |
air.update.events.UpdateEventpropriété UpdateEvent.type =
air.update.events.UpdateEvent.BEFORE_INSTALL| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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).
UpdateEvent.BEFORE_INSTALL définit la valeur de la propriété type de l’objet d’événement pour un événement beforeInstall.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | L’objet updater. |
checkForUpdate | Evénement |
air.update.events.UpdateEventpropriété UpdateEvent.type =
air.update.events.UpdateEvent.CHECK_FOR_UPDATE| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
UpdateEvent.CHECK_FOR_UPDATE définit la valeur de la propriété type de l’objet d’événement pour un événement checkForUpdate.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | L’objet updater. |
downloadComplete | Evénement |
air.update.events.UpdateEventpropriété UpdateEvent.type =
air.update.events.UpdateEvent.DOWNLOAD_COMPLETE| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Distribué une fois le téléchargement du fichier de mise à jour terminé.
La constanteUpdateEvent.DOWNLOAD_COMPLETE définit la valeur de la propriété type de l’objet d’événement pour un événement downloadComplete.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | L’objet updater. |
downloadError | Evénement |
air.update.events.DownloadErrorEventpropriété DownloadErrorEvent.type =
air.update.events.DownloadErrorEvent.DOWNLOAD_ERROR| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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 constanteDownloadErrorEvent.DOWNLOAD_ERROR définit la valeur de la propriété type de l’objet d’événement pour un événement downloadError.
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.
| Code d’erreur | Description |
|---|---|
| 16800 | Se produit lors de la validation du fichier de mise à jour téléchargé. Il est possible que la propriété subErrorID contienne des informations supplémentaires. |
| 16801 | Fichier Adobe AIR non valide (application.xml manquant). |
| 16802 | Fichier Adobe AIR non valide (type MIME manquant). |
| 16803 | Fichier Adobe AIR non valide (format). |
| 16804 | Fichier Adobe AIR non valide (indicateurs non valides). |
| 16805 | Fichier Adobe AIR non valide (compression inconnue). |
| 16806 | Fichier Adobe AIR non valide (nom de fichier incorrect). |
| 16807 | Fichier Adobe AIR non valide (fichier corrompu). |
| 16808 | Le fichier de configuration n’existe pas. |
| 16809 | La propriété updateURL n’est pas définie. |
| 16810 | Réservé. |
| 16811 | Fichier de configuration non valide (version de configuration inconnue). |
| 16812 | Fichier de configuration non valide (URL manquante). |
| 16813 | Fichier de configuration non valide (format du délai). |
| 16814 | Fichier de configuration non valide (valeurs defaultUI non valides). |
| 16815 | Descripteur de mise à jour non valide (version du descripteur inconnue). |
| 16816 | Descripteur de mise à jour non valide (version de mise à jour manquante). |
| 16817 | Descripteur de mise à jour non valide (description non valide). |
| 16818 | Erreur d’E/S lors de l’enregistrement des données sur le disque. Il est possible que la propriété subErrorID fournisse davantage d’informations. |
| 16819 | Erreur de sécurité lors du téléchargement. Il est possible que la propriété subErrorID fournisse davantage d’informations. |
| 16820 | Code d’état HTTP non valide. Il est possible que la propriété subErrorID contienne un code d’état non valide. |
| 16821 | Réservé. |
| 16822 | Erreur d’E/S lors du téléchargement. Il est possible que la propriété subErrorID fournisse davantage d’informations. |
| 16823 | Erreur de fin de fichier lors de l’enregistrement des données sur le disque. Il est possible que la propriété subErrorID fournisse davantage d’informations. |
| 16824 | Descripteur de mise à jour non valide. Il est possible que la propriété subErrorID fournisse davantage d’informations. |
| 16825 | Le fichier de mise à jour contient une application avec un ID d’application différent. |
| 16826 | Le fichier de mise à jour ne contient pas une version plus récente de l’application. |
| 16827 | La version contenue dans le fichier de mise à jour ne correspond pas à celle du fichier descripteur de mise à jour. |
| 16828 | Mise à jour de l’application impossible, car l’application est exécutée dans l’application de débogage du lanceur AIR (ADL). |
| 16829 | Fichier de mise à jour manquant au moment de l’installation. |
downloadStart | Evénement |
air.update.events.UpdateEventpropriété UpdateEvent.type =
air.update.events.UpdateEvent.DOWNLOAD_START| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
UpdateEvent.DOWNLOAD_START définit la valeur de la propriété type de l’objet d’événement pour un événement downloadStart.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | L’objet updater. |
error | Evénement |
flash.events.ErrorEventpropriété ErrorEvent.type =
flash.events.ErrorEvent.ERROR| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Distribué lorsqu’une erreur s’est produite lors de l’initialisation ou la mise à jour (si une erreur inattendue est survenue).
Définit la valeur de la propriététype d’un objet d’événement error.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet qui subit l’échec de l’opération réseau. |
text | Texte à afficher en tant que message d’erreur. |
fileUpdateError | Evénement |
air.update.events.StatusFileUpdateErrorEventpropriété StatusFileUpdateErrorEvent.type =
air.update.events.StatusFileUpdateErrorEvent.FILE_UPDATE_ERROR| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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().
StatusUpdateErrorEvent.UPDATE_ERROR définit la valeur de la propriété type de l’objet événement pour un événement statusUpdateError.
fileUpdateStatus | Evénement |
air.update.events.StatusFileUpdateEventpropriété StatusFileUpdateEvent.type =
air.update.events.StatusFileUpdateEvent.FILE_UPDATE_STATUS| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Distribué après que le programme de mise à jour a correctement validé le fichier lors de l’appel de la méthode installFromAIRFile().
StatusUpdateEvent.UPDATE_STATUS définit la valeur de la propriété type de l’objet d’événement pour un événement updateStatus.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
available | Indique si une version différente de celle de l’application actuelle est disponible (true) ou s’il s’agit de la même version (false). |
path | Propriété nativePath de l’objet File de mise à jour spécifié par le paramètre airFile lors d’un appel de la méthode installFromAIRFile(). |
version | Indique la version de la nouvelle mise à jour. |
initialized | Evénement |
air.update.events.UpdateEventpropriété UpdateEvent.type =
air.update.events.UpdateEvent.INITIALIZED| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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 surtrues’il s’agit de la première exécution après une mise à jour réussie, surfalsedans le cas contraire. -
previousVersion(String) La version précédente de l’application avant la mise à niveau (définie uniquement siisfirstRunesttrue). -
currentVersion(String) La version du fichier descripteur d’application de la version actuellement installée.
UpdateEvent.INITIALIZED définit la valeur de la propriété type de l’objet d’événement pour un événement initialized.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | L’objet updater. |
progress | Evénement |
flash.events.ProgressEventpropriété ProgressEvent.type =
flash.events.ProgressEvent.PROGRESS| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Distribué lors du téléchargement du fichier de mise à jour.
Définit la valeur de la propriététype d’un objet événement progress.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
bubbles | false |
bytesLoaded | Nombre d’éléments ou d’octets chargés lors du traitement de l’événement par l’écouteur. |
bytesTotal | Nombre total d’éléments ou d’octets qui seront chargés si le processus de chargement aboutit. |
cancelable | false ; il n’existe aucun comportement par défaut à annuler. |
currentTarget | L’objet qui traite activement l’objet Event avec un écouteur d’événements. |
target | Objet indiquant la progression. |
updateError | Evénement |
air.update.events.StatusUpdateErrorEventpropriété StatusUpdateErrorEvent.type =
air.update.events.StatusUpdateErrorEvent.UPDATE_ERROR| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
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.
StatusUpdateErrorEvent.UPDATE_ERROR définit la valeur de la propriété type de l’objet événement pour un événement statusUpdateError.
updateStatus | Evénement |
air.update.events.StatusUpdateEventpropriété StatusUpdateEvent.type =
air.update.events.StatusUpdateEvent.UPDATE_STATUS| Version du langage: | ActionScript 3.0 |
| Versions du moteur d’exécution: | AIR 1.5 |
Distribué une fois que le programme de mise à jour a correctement téléchargé et interprété le fichier descripteur de mise à jour.
La constanteStatusUpdateEvent.UPDATE_STATUS définit la valeur de la propriété type de l’objet d’événement pour un événement updateStatus.
Les propriétés de cet événement sont les suivantes :
| Propriété | Valeur |
|---|---|
available | Définie sur true si le fichier descripteur de mise à jour indique une version différente de celle de l’application actuelle, ou sur false s’il s’agit de la même version. |
version | Chaîne représentant la nouvelle version disponible. |
details | Tableau définissant la chaîne details pour chaque langue prise en charge. S’il n’existe aucune description localisée, elle est définie en tant que tableau dans lequel le premier élément est une chaîne vide ("") et le second élément est la chaîne détails. S’il existe des descriptions localisées, chaque élément dans le tableau est un tableau avec deux éléments. Le premier élément est le code régional et le second élément correspond à la description. Par exemple, le tableau suivant comporte deux sous-tableaux pour deux langues (anglais des Etats-Unis et français) : ["en-US", "Hello World"], ["fr", "Bonjour monde"]. Les langues sont classées dans le même ordre que dans le fichier descripteur de mise à jour. Le texte de la propriété details est spécifié dans le fichier descripteur de mise à jour. |
versionLabel | (AIR 2.5+) Libellé de version du fichier descripteur d’application de la mise à jour. C’est le libellé de version, et non la version, qui doit être présenté aux utilisateurs. Si aucun libellé de version n’est spécifié, cette propriété est une chaîne vide. |
Tue Jun 12 2018, 09:30 AM Z