Plik konfiguracyjny aktualizacji jest plikiem XML. Może zawierać następujące elementy:
-
updateURL
— ciąg znaków (String). Reprezentuje lokalizację deskryptora aktualizacji na serwerze zdalnym. Dozwolone są wszelkie poprawne lokalizacje URLRequest. Właściwość
updateURL
musi być zdefiniowana — albo w pliku konfiguracyjnym, albo za pomocą skryptu (zobacz
Definiowanie plików deskryptora aktualizacji i dodawanie pliku AIR do serwera internetowego
). Właściwość tę należy zdefiniować przed użyciem obiektu Updater (przed wywołaniem metody
initialize()
obiektu Updater, co opisano w sekcji
Inicjowanie architektury aktualizacji
).
-
delay
— liczba (Number). Reprezentuje interwał (w dniach, dozwolone są wartości ułamkowe, takie jak
0.25
) sprawdzania dostępności aktualizacji. Wartość 0 (domyślna) określa, że obiekt Updater nie będzie okresowo automatycznie sprawdzał dostępności aktualizacji.
Plik konfiguracyjny dla klasy ApplicationUpdaterUI może, oprócz elementów
updateURL
i
delay
, zawierać następujący element:
-
defaultUI
: lista elementów
dialog
. Każdy element
dialog
ma atrybut
name
odpowiadający oknu dialogowemu w interfejsie użytkownika. Każdy element
dialog
ma atrybut
visible
określający, czy okno dialogowe jest widoczne. Wartością domyślną jest
true
. Oto możliwe wartości atrybutu
name
:
-
"checkForUpdate"
— odpowiada oknom dialogowym Sprawdź dostępność aktualizacji, Brak aktualizacji i Błąd aktualizacji.
-
"downloadUpdate"
— odpowiada oknu dialogowemu Pobierz aktualizację.
-
"downloadProgress"
— odpowiada oknom dialogowym Postęp pobierania i Błąd pobierania.
-
"installUpdate"
— odpowiada oknu dialogowemu Zainstaluj aktualizację.
-
"fileUpdate"
— odpowiada oknom dialogowym Aktualizacja pliku, Plik nie jest aktualizacją i Błąd pliku.
-
"unexpectedError"
— odpowiada oknu dialogowemu Nieoczekiwany błąd.
Ustawienie wartości
false
powoduje, że odpowiednie okna dialogowe nie będą pojawiać się w trakcie procedury aktualizacji.
Oto przykładowy plik konfiguracyjny dla architektury 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>
Oto przykładowy plik konfiguracyjny dla architektury ApplicationUpdaterUI zawierający definicję elementów
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>
Właściwość
configurationFile
powinna wskazywać na położenie tego pliku:
Przykład w języku ActionScript:
appUpdater.configurationFile = new File("app:/cfg/updateConfig.xml");
Przykład w języku JavaScript:
appUpdater.configurationFile = new air.File("app:/cfg/updateConfig.xml");
Katalog templates architektury aktualizacji zawiera przykładowy plik konfiguracyjny o nazwie config-template.xml.