Events

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

Ereignis-Listener-Einrichtung

Um auf Ereignisse zu hören, verwenden Sie die 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

Fired während des Bundle-Download-Prozesses. Bietet Informationen zum Download-Progress.

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

Ereignisdaten:

• percent: Anzahl - Download-Progress-Prozent (0-100)
• bundle: BundleInfo - Informationen über das heruntergeladene Bundle

Hinweis

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

noNeedUpdate

Fired when a check for updates determines that no update is needed.

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

Ereignis-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
});

Event Daten:

• 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
});

Event Daten:

• bundle: BundleInfo - Informationen über das heruntergeladene Updatepaket

majorAvailable

Ein Update ist verfügbar, aber durch die automatische Aktualisierungseinstellungen blockiert.

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

Event Daten:

• version: string - Die Versionsnummer der großen Aktualisierung

Tip

Benutzerbestätigung oder App-Store-Updates sind für größere Updates üblich. Verwenden Sie dieses Ereignis, um die Benutzer entsprechend zu informieren.

updateFailed

Fired when an update has failed to install at the next app start.

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

Ereignisdaten:

• bundle: string - Die Versionsnummer der großen Aktualisierung

downloadFailed

: string - Ausgelöst, wenn eine 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 werden konnte

appReloaded

Ausgelöst, wenn die App neu geladen wurde

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

Ereignisdaten: 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);
});

Ereignisdaten:

• bundle: BundleInfo - Informationen über die aktuelle Bundle
• status: string - Der Status der Vorbereitung

Vorsicht

Denken Sie daran, 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' - Bundle wurde erfolgreich heruntergeladen
• 'error' - Bundle herunterladen/Installieren fehlgeschlagen
• 'pending' - Bundle ist für die nächste Installation vorbereitet
• 'downloading' - Bundle wird derzeit heruntergeladen

- Beispiel: Vollständiger Update-Flow

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

- Vorsicht

- Dies UpdateManager Klasse enthält nicht die CapacitorUpdater.notifyAppReady() Aufruf erforderlich für den automatischen Update-Flow. Platzieren Sie die notifyAppReady-Aufruf korrekt. Für weitere Informationen besuchen Sie die Dokumentation.

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
  }
}

Empfehlungen

1. Always aufrufen notifyAppReady(): When using auto-update, always call this method after your app initializes to prevent rollback.

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

3. Bieten Sie Benutzerfeedback anVerwenden Sie das Download-Progress-Ereignis, um dem Benutzer den Update-Fortschritt anzuzeigen.

4. Räumen Sie die Listener auf: Entfernen Sie Ereignislistener, 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.

Fortsetzen von Ereignissen

Wenn Sie Capgo verwenden Ereignisse um native Plugin-Arbeit zu planen, verbinden Sie es mit Verwenden Sie @capgo/capacitor-Updater für die native Fähigkeit in der Verwendung von @capgo/capacitor-Updater, Capgo Plugin-Verzeichnis für den Produktworkflow in Capgo Plugin-Verzeichnis, Capacitor Plugins durch Capgo zur Implementierungsdetail in Capacitor Plugins durch Capgo Plugins hinzufügen oder aktualisieren zur Implementierungsdetail in Plugins hinzufügen oder aktualisieren, und Ionische Unternehmenseigenen Plugin-Alternativen zur Produktworkflow in Ionische Unternehmenseigenen Plugin-Alternativen.