Ereignisse

Der Capacitor Updater-Plugin bietet mehrere Ereignisse, die Sie zum Überwachen des Update-Prozesses und zum Reagieren auf verschiedene Zustände anhören können.

Ereignis-Listener-Einrichtung

Um auf Ereignisse zu hören, verwenden Sie das addListener Methode auf dem CapacitorUpdater Objekt:

import { CapacitorUpdater } from '@capgo/capacitor-updater';

// Add a listener
const listener = await CapacitorUpdater.addListener('eventName', (event) => {
  // Handle the event
});

// Remove the listener when no longer needed
listener.remove();

// Remove all listeners
await CapacitorUpdater.removeAllListeners();

Verfügbare Ereignisse

download

Wird während des Herunterladeprozesses des Bundles ausgelöst. Bietet Informationen zum Herunterladestatus an.

CapacitorUpdater.addListener('download', (event) => {
  console.log(`Download progress: ${event.percent}%`);
  console.log('Bundle info:', event.bundle);
});

Ereignisdaten:

• percent: Zahl - Herunterladestatus in Prozent (0-100)
• bundle: BundleInfo - Informationen über das heruntergeladene Bundle

Hinweis

Dieser Event wird mehrmals während des Downloads ausgelöst, um den Fortschritt zu melden.

noNeedUpdate

Ausgelöst, wenn eine Überprüfung auf Aktualisierungen ergibt, dass keine Aktualisierung erforderlich ist.

CapacitorUpdater.addListener('noNeedUpdate', (event) => {
  console.log('App is up to date');
  console.log('Current bundle:', event.bundle);
});

Event-Daten:

• bundle: BundleInfo - Informationen über das aktuelle Bundle

updateAvailable

Ausgelöst, wenn eine neue Aktualisierung zum Herunterladen verfügbar ist.

CapacitorUpdater.addListener('updateAvailable', (event) => {
  console.log('Update available');
  console.log('New bundle:', event.bundle);
  // You can trigger a download here if needed
});

Ereignisdaten:

• bundle: BundleInfo - Informationen über das verfügbare Updatepaket

downloadComplete

Ausgelöst, wenn ein Updatepaket erfolgreich heruntergeladen wurde.

CapacitorUpdater.addListener('downloadComplete', (event) => {
  console.log('Download completed');
  console.log('Downloaded bundle:', event.bundle);
  // You might want to set this bundle as next
});

Ereignisdaten:

• bundle: BundleInfo - Informationen über das heruntergeladene Updatepaket

majorAvailable

Ausgelöst, wenn ein großer Update verfügbar ist, aber durch die Einstellungen für automatische Updates blockiert wird.

CapacitorUpdater.addListener('majorAvailable', (event) => {
  console.log('Major update available:', event.version);
  // Notify user about major update
});

Ereignisdaten:

• version: string - Die Versionsnummer des großen Updates

Tip

Große Updates erfordern in der Regel die Bestätigung des Benutzers oder eine App-Store-Update. Verwenden Sie dieses Ereignis, um Benutzer entsprechend zu informieren.

updateFailed

Ausgelöst, wenn ein Update bei der nächsten App-Start nicht installiert werden konnte.

CapacitorUpdater.addListener('updateFailed', (event) => {
  console.error('Update failed to install');
  console.log('Failed bundle:', event.bundle);
  // Handle rollback or retry logic
});

Ereignisdaten:

• bundle: BundleInfo - Informationen über das Bundle, das nicht installiert werden konnte

downloadFailed

Ausgelöst, wenn ein Bundle-Download fehlschlägt.

CapacitorUpdater.addListener('downloadFailed', (event) => {
  console.error('Download failed for version:', event.version);
  // Handle download retry logic
});

Ereignisdaten:

• version: string - Die Version, die nicht heruntergeladen wurde

appReloaded

Ausgelöst, wenn die App neu geladen wurde.

CapacitorUpdater.addListener('appReloaded', () => {
  console.log('App has been reloaded');
  // Perform any necessary reinitialization
});

Daten zum Ereignis: Keine

appReady

Ausgelöst, wenn die App nach einer Aktualisierung bereit zum Einsatz ist.

CapacitorUpdater.addListener('appReady', (event) => {
  console.log('App is ready');
  console.log('Current bundle:', event.bundle);
  console.log('Status:', event.status);
});

Daten zum Ereignis:

• bundle: BundleInfo - Informationen über die aktuelle Bundle
• status: string - Der Bereitschaftsstatus

Vorsicht

Denken Sie daran, aufzurufen notifyAppReady() innerhalb der konfigurierten Zeitüberschreitung (Standard 10 Sekunden), um eine automatische Rolloverung zu verhindern.

BundleInfo-Objekt

Viele Ereignisse enthalten ein BundleInfo Objekt mit den folgenden Eigenschaften:

interface BundleInfo {
  id: string;           // Unique bundle identifier
  version: string;      // Bundle version
  downloaded: string;   // Download timestamp
  checksum?: string;    // Bundle checksum (if available)
  status: BundleStatus; // Bundle status
}

Wo BundleStatus sind:

• 'success' - Das Bundle wurde erfolgreich heruntergeladen
• 'error' - Download/Installation des Bundles fehlgeschlagen
• 'pending' - Der Bundle ist noch nicht als nächstes gesetzt
• 'downloading' - Der Bundle wird derzeit heruntergeladen

Beispiel: Vollständiger Update-Flow

Hier ist ein Beispiel für die Behandlung des vollständigen Update-Flows mit Ereignissen:

Vorsicht

Dies UpdateManager Diese Klasse enthält nicht die CapacitorUpdater.notifyAppReady() Aufruf erforderlich für den automatischen Update-Flow. Bitte sehen Sie sich die Platzierung der notifyAppReady-Aufruf richtig an Dokumentation für weitere Informationen.

import { CapacitorUpdater } from '@capgo/capacitor-updater';

export class UpdateManager {
  private listeners: any[] = [];

  async setupListeners() {
    // Listen for available updates
    this.listeners.push(
      await CapacitorUpdater.addListener('updateAvailable', async (event) => {
        console.log('Update available:', event.bundle.version);
        // Auto-download the update
        await CapacitorUpdater.download({
          url: event.bundle.url,
          version: event.bundle.version
        });
      })
    );

    // Monitor download progress
    this.listeners.push(
      await CapacitorUpdater.addListener('download', (event) => {
        console.log(`Downloading: ${event.percent}%`);
        // Update UI progress bar
        this.updateProgressBar(event.percent);
      })
    );

    // Handle download completion
    this.listeners.push(
      await CapacitorUpdater.addListener('downloadComplete', async (event) => {
        console.log('Download complete:', event.bundle.version);
        // Set as next bundle
        await CapacitorUpdater.next({ id: event.bundle.id });
      })
    );

    // Handle failures
    this.listeners.push(
      await CapacitorUpdater.addListener('downloadFailed', (event) => {
        console.error('Download failed:', event.version);
        this.showError('Update download failed. Please try again later.');
      })
    );

    this.listeners.push(
      await CapacitorUpdater.addListener('updateFailed', (event) => {
        console.error('Update installation failed:', event.bundle.version);
        this.showError('Update installation failed. The app has been rolled back.');
      })
    );

    // Handle app ready
    this.listeners.push(
      await CapacitorUpdater.addListener('appReady', async (event) => {
        console.log('App ready with bundle:', event.bundle.version);
      })
    );
  }

  cleanup() {
    // Remove all listeners when no longer needed
    this.listeners.forEach(listener => listener.remove());
    this.listeners = [];
  }

  private updateProgressBar(percent: number) {
    // Update your UI progress bar
  }

  private showError(message: string) {
    // Show error to user
  }
}

Gute Praktiken

1. Rufen Sie immer notifyAppReady(): Wenn Sie die automatische Aktualisierung verwenden, rufen Sie diese Methode immer nach der Initialisierung Ihrer App auf, um einen Rollover zu vermeiden.

2. Fehler verarbeiten: Implementieren Sie eine ordnungsgemäße Fehlerbehandlung für Download- und Aktualisierungsfehler.

3. Benutzerfeedback bereitstellen: Verwenden Sie das Download-Progress-Ereignis, um dem Benutzer den Update-Progress anzuzeigen.

4. Hören Sie auf, Listener: Entfernen Sie Ereignis-Listener, wenn sie nicht mehr benötigt werden, um Speicherlecks zu vermeiden.

5. Testupdate-Szenarien: Testen Sie verschiedene Update-Szenarien, einschließlich Fehlschlägen, Rollover und großen Updates.