ApplicationUpdater  - AS3

De locatie van het configuratiebestand waarin de waarden zijn ingesteld voor de eigenschappen delay en updateURL. Als deze eigenschap naar een niet-bestaand bestand verwijst, treedt er een fout op als de methode initialize() wordt aangeroepen.

Hier volgt een voorbeeld van een configuratiebestand:

 <?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>
        </configuration>

In plaats van een configuratiebestand te laden, kunt u ActionScript-code gebruiken om de eigenschappen delay en updateURL in te stellen.

Verwante API-elementen

De interne status van de updater. U kunt de volgende waarden instellen voor de eigenschap:

• "UNINITIALIZED" — De updater is niet geïnitialiseerd.

• "INITIALIZING" — De updater wordt geïnitialiseerd.

• "READY" — De updater is geïnitialiseerd.

• "BEFORE_CHECKING" — De updater heeft nog niet gecontroleerd of er een updatebeschrijvingsbestand is.

• "CHECKING" — De updater controleert of er een updatebeschrijvingsbestand is.

• "AVAILABLE" — Het updatebeschrijvingsbestand is beschikbaar.

• "DOWNLOADING" — De updater downloadt het AIR-bestand.

• "DOWNLOADED" — De updater heeft het AIR-bestand gedownload.

• "INSTALLING" — De updater installeert het AIR-bestand.

• "PENDING_INSTALLING" — De updater is geïnitialiseerd en er zijn updates in behandeling.

De huidige versie van de toepassing. Deze eigenschap wordt ingesteld tijdens het aanroepen van de methode initialize(). De eigenschap wordt ingesteld op de versie uit het toepassingsbeschrijvingsbestand.

Het interval, in dagen, tussen periodieke controles op nieuwe updates.

De waarde 0 (de standaardwaarde) geeft aan dat de timer niet actief is, zodat er geen periodieke controles worden uitgevoerd. Dit kan worden ingesteld via deze eigenschap of via het configuratiebestand. Wanneer de waarde is ingesteld met beide methoden, wordt de waarde gebruikt die met de eigenschap is ingesteld.

De standaardwaarde is 0.

Geeft aan of dit de eerste uitvoering is na een geslaagde update (true) of niet (false). Deze waarde wordt ingesteld na het aanroepen van de methode initialize(). De ontwikkelaar moet controleren of isFirstRun op true is ingesteld als er gegevens moeten worden gemigreerd van de ene versie naar een andere.

Verwante API-elementen

Een functie die de updater moet gebruiken om versies te vergelijken. Standaard worden versies vergeleken om te bepalen of de versie van de externe site nieuwer is dan de versie van de geïnstalleerde toepassing. Soms komt de standaardvergelijkingsfunctie echter niet overeen met het versieschema van de ontwikkelaar. Stel deze eigenschap in om een nieuwe vergelijkingsfunctie op te geven.

De standaardvergelijkingsfunctie accepteert versies zoals x.y.z, waarbij x, y en z letters en cijfers kunnen bevatten. Er zijn enkele speciale voorwaarden die de standaardvergelijkingsfunctie herkent. Als de testfunctie "alpha", "beta" of "rc" aantreft in de versietekenreeksen, is de volgorde: alpha < beta < rc.

appUpdate.isNewerVersionFunction = customFn; 

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

De vorige locatie van de opslagmap van de toepassing, als deze na een update is gewijzigd. De locatie van de opslagmap van de toepassing wordt gewijzigd na een upgrade met een certificaatmigratie. Als er geen certificaatmigratie plaatsvindt, verandert de opslagmap van de toepassing niet wanneer de gebruiker de toepassing bijwerkt. en deze eigenschap wordt ingesteld op null. Deze eigenschap wordt ingesteld tijdens het aanroepen van de methode initialize().

Een nieuwe versie van een AIR-toepassing kan met een nieuw certificaat worden ondertekend als de ontwikkelaar de optie -migrate gebruikt wanneer het AIR-pakket wordt gemaakt met ADT. Als een nieuwe versie van een AIR-toepassing een nieuw handtekeningcertificaat gebruikt, verandert de lokale opslagmap van de toepassing wanneer de gebruiker de nieuwe versie installeert. Gebruik deze eigenschap om gegevens vanuit de oude opslagmap van de toepassing over te brengen naar de nieuwe opslagmap (File.applicationStorageDirectory). Raadpleeg 'Een AIR-bestand ondertekenen om het toepassingscertificaat te wijzigen' in het hoofdstuk 'AIR-toepassingen maken met de opdrachtregelprogramma's' van de handleiding voor ontwikkelaars van Adobe AIR voor meer informatie.

De vorige versie van de toepassing. Deze eigenschap wordt ingesteld tijdens het aanroepen van de methode initialize(). Retourneert de vorige versie van de toepassing vóór de upgrade (wordt alleen ingesteld als isfirstRun true is); anders is de waarde null.

De inhoud van het updatebeschrijvingsbestand dat is gedownload uit de update-URL. Deze eigenschap is alleen niet null nadat het updaterobject een gebeurtenis updateStatus heeft verzonden.

De locatie van het updatebeschrijvingsbestand. Elke locatie die geldig is voor een URLRequest-pad, wordt geaccepteerd. Dit is de enige verplichte instelling voor de updater. U kunt de URL van de update instellen via deze eigenschap of via het configuratiebestand. Waneer de waarde met beide methoden is ingesteld, gebruikt de updater de waarde die met deze eigenschap is ingesteld.

Geeft aan of er een uitgestelde update was, ook als de installatie daarvan is mislukt (true); anders is de waarde false. Deze eigenschap wordt ingesteld tijdens het aanroepen van de methode initialize(). Gebruik de eigenschappen wasPendingUpdate en isFirstRun om te controleren of de installatie van een update is mislukt (in dat geval is wasPendingUpdate ingesteld op true en is isFirstRun ingesteld op false).

Verwante API-elementen

De constructorfunctie.

Hiermee wordt het updateproces geannuleerd. Als deze methode wordt aangeroepen, worden alle downloads die in behandeling zijn, geannuleerd, worden alle onvolledig gedownloade bestanden verwijderd en wordt de periodieke controletimer opnieuw gestart.

Het updateproces kan op elk moment worden geannuleerd, behalve wanneer de status "UNINITIALIZED" of "INITIALIZING" is. Er gebeurt niets wanneer de methode wordt aangeroepen als de status "UNINITIALIZED" of "INITIALIZING" is.

Het updatebeschrijvingsbestand wordt asynchroon gedownload en geïnterpreteerd. Als deze methode wordt aangeroepen, verandert de status van de updater in "CHECKING". Roep deze methode alleen aan als de gebeurtenis checkForUpdate is geannuleerd.

Deze methode wordt alleen uitgevoerd wanneer de updater de status "BEFORE_CHECKING" heeft.

Het updateproces starten. Als deze methode wordt aangeroepen, wordt de periodieke timer niet gestopt. Er wordt echter ontdekt dat er een updateproces wordt uitgevoerd en de huidige iteratie wordt overgeslagen.

Deze methode wordt alleen uitgevoerd als de huidige status "READY" is.

Deze methode kan ertoe leiden dat het updaterobject de volgende gebeurtenis verzendt:

Het updatebestand wordt asynchroon gedownload. Als deze methode wordt aangeroepen, verandert de status in "DOWNLOADING". Deze methode moet alleen worden aangeroepen als de gebeurtenis StatusUpdateEvent.UPDATE_STATUS is geannuleerd toen de eigenschap available van de gebeurtenis waar was.

Deze methode wordt alleen uitgevoerd als de huidige status "AVAILABLE" is.

Hiermee wordt de updater geïnitialiseerd. Als u deze methode aanroept, gebeurt het volgende:

1. Het updateframework wordt geïnitialiseerd en alle updates die in behandeling zijn, worden stil (en synchroon) geïnstalleerd. U moet deze methode tijdens het starten van de toepassing aanroepen, omdat de toepassing mogelijk opnieuw moet worden opgestart.

2. Als er een uitgestelde update aanwezig is, wordt deze geïnstalleerd.

3. Als er iets verkeerd is gegaan tijdens een vorige update, worden het updatebestand en de versiegegevens in het opslaggebied gewist.

4. Als de tijd van de periodieke timer is verstreken, wordt het updateproces gestart; anders wordt de periodieke timer gestart. Wanneer u echter een toepassing test met de toepassing AIR Debug Launcher (ADL), wordt de uitzondering IllegalOperationError gegenereerd als u probeert de toepassing bij te werken.

Hiermee wordt het updateproces gestart met een lokaal AIR-bestand.

Het aanroepen van deze methode heeft geen effect als er een updateproces wordt uitgevoerd (als de status niet "DOWNLOADED" is).

Deze functie is nuttig voor een toepassing waarbij het element customUpdateUI is ingesteld op true in het toepassingsbeschrijvingsbestand.

Wanneer u een toepassing test met de toepassing AIR Debug Launcher (ADL), leidt het aanroepen van deze methode tot de uitzondering IllegalOperationError.

Parameters

Hiermee wordt het updatebestand geïnstalleerd. Als deze methode wordt aangeroepen, verandert de status in "INSTALLING" en deze methode moet alleen worden aangeroepen als de gebeurtenis downLoadComplete is geannuleerd.

Roep deze methode aan wanneer de updater de status "DOWNLOADED" heeft. Als u deze methode bij een andere status aanroep, gebeurt er niets.

Wanneer u een toepassing test met de toepassing AIR Debug Launcher (ADL), leidt het aanroepen van deze methode tot de uitzondering IllegalOperationError.

Wordt verzonden vlak voordat de update wordt geïnstalleerd, nadat de methode installUpdate() is aangeroepen. Het is soms beter om de installatie van de update op dit moment te verhinderen, omdat de gebruiker al het huidige werk zou kunnen kwijtraken wanneer de runtime de toepassing afsluit om de update te installeren.

Door de methode preventDefault() van deze gebeurtenis aan te roepen, wordt de installatie uitgesteld totdat de toepassing opnieuw wordt gestart. Als u de methode preventDefault() aanroept, kan er geen ander updateproces worden gestart tijdens deze toepassingssessie (via het aanroepen van de methode installUpdate() of wegens de periodieke controle).

Standaard wordt het updatebeschrijvingsbestand gedownload door de ApplicationUpdater-bibliotheek. U kunt de methode preventDefault() aanroepen om dit standaardgedrag te annuleren.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden voordat het updateproces begint, vlak voordat de updater het updatebeschrijvingsbestand probeert te downloaden. De updater kan deze gebeurtenis verzenden nadat de methode checkNow() rechtstreeks is aanroepen of omdat de timer voor periodieke controle is verlopen.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden wanneer het downloaden van updatebestand is voltooid.

Deze gebeurtenis wordt gewoonlijk gebruikt om een bericht weer te geven waarin wordt gevraagd of de gebruiker wil doorgaan met de installatie van de update.

Standaard wordt de methode installUpdate() automatisch aangeroepen door de ApplicationUpdater-bibliotheek.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden als er een fout optreedt wanneer verbinding wordt gemaakt met het updatebestand of wanneer het wordt gedownload. Wordt ook verzonden voor een ongeldige HTTP-status (zoals 404 - Bestand niet gevonden).

Wanneer deze gebeurtenis wordt verzonden, wordt de periodieke timer automatisch opnieuw gestart (als de vertraging groter is dan 0).

De eigenschap errorID van een object DownloadErrorEvent is een geheel getal waarmee informatie over de fout wordt gedefinieerd (zie de volgende tabel). Een extra eigenschap subErrorID kan meer informatie over de fout bevatten.

Wordt verzonden nadat de methode downloadUpdate() is aangeroepen en de verbinding met de server tot stand is gebracht. Wanneer u de ApplicationUpdater-bibliotheek gebruikt, kunt u met de gebeurtenishandler voor deze gebeurtenis een voortgangsbalk weergeven om de voortgang van het downloaden aan de gebruiker te tonen.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden wanneer er een fout is opgetreden tijden de initialisatie of tijdens het updateproces (als er iets onverwachts is gebeurd).

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden wanneer er een fout optreedt tijdens het valideren van het bestand dat is doorgegeven met de parameter airFile in een aanroep van de methode installFromAIRFile().

Wordt verzonden nadat het bestand in de aanroep van de methode installFromAIRFile() met succes is gevalideerd.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden nadat de initialisatie is voltooid.

Deze gebeurtenis heeft de volgende eigenschappen:

Verzonden tijdens het downloaden van het updatebestand.

Deze gebeurtenis heeft de volgende eigenschappen:

Wordt verzonden als er een fout optreedt wanneer wordt geprobeerd het updatebeschrijvingsbestand te downloaden of te parseren.

Wanneer deze gebeurtenis door de updater wordt verzonden, wordt de periodieke timer automatisch opnieuw gestart (als de vertraging groter is dan 0). De toepassing zou dialoogvensters met foutmeldingen kunnen verbergen wanneer de updater een nieuwe gebeurtenis checkForUpdate verzendt.

Wordt verzonden nadat het updatebeschrijvingsbestand met succes is gedownload en geïnterpreteerd.

Standaard start het downloaden van de update als de eigenschap available van het object StatusUpdateEvent is ingesteld op true. Dit standaardgedrag kan alleen worden verhinderd bij gebruik van de klasse ApplicationUpdater, niet bij gebruik van de klasse ApplicationUpdatorUI.

Deze gebeurtenis heeft de volgende eigenschappen: