Événements

Copiez une invite de configuration avec les étapes d'installation et la guide markdown complète pour ce plugin.

Le plugin de mise à jour Capacitor fournit plusieurs événements que vous pouvez écouter pour surveiller le processus de mise à jour et répondre à différents états.

Configuration de l'écouteur d'événements

Pour écouter les événements, utilisez la addListener méthode sur l' CapacitorUpdater objet :

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();

Événements disponibles

`download`

Fait pendant le processus de téléchargement du bundle. fournit des informations sur le téléchargement en cours.

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

Event Data:

percent: nombre - Pourcentage de progression du téléchargement (0-100)
bundle: BundleInfo - Informations sur le bundle en cours de téléchargement

`noNeedUpdate`

Fait lorsqu'une vérification de mise à jour détermine qu'aucune mise à jour n'est nécessaire.

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

Event Data:

bundle: BundleInfo - Informations sur le bundle actuel

`updateAvailable`

Un nouveau mise à jour est disponible pour le téléchargement.

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

Event Data:

bundle: BundleInfo - Informations sur le bundle de mise à jour disponible

`downloadComplete`

Déclenché lorsqu'un téléchargement de bundle a été effectué avec succès.

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

Event Data:

bundle: BundleInfo - Informations sur le bundle téléchargé

`majorAvailable`

Un majeur est disponible mais bloqué par les paramètres d'actualisation automatique.

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

Event Data:

version: chaîne - Le numéro de version de la mise à jour majeure

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

Event Data:

bundle: Informations sur le bundle qui n'a pas pu être installé

`downloadFailed`

Déclenché lorsqu'un téléchargement de bundle a échoué.

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

Event Data:

version: chaîne - La version qui n'a pas pu être téléchargée

`appReloaded`

Fired when the app has been reloaded.

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

Event Data: None

`appReady`

Fired when the app is ready to use after an update.

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

Event Data:

bundle: BundleInfo - Informations sur le bundle actuel
status: chaîne - L'état prêt

Objet BundleInfo

De nombreux événements incluent un BundleInfo objet avec les propriétés suivantes :

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
}

Où BundleStatus peut être :

'success' - Le bundle a été téléchargé avec succès
'error' - Le téléchargement/ installation du bundle a échoué
'pending' - La mise à jour du bundle est en attente.
'downloading' - Le bundle est actuellement téléchargé

Exemple : Flux de mise à jour complet

Voici un exemple de gestion de la mise à jour complète avec des événements :

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

Toujours appeler

Appellez toujours notifyAppReady(): When using auto-update, always call this method after your app initializes to prevent rollback.
Meilleures pratiques: Gérer correctement les erreurs de téléchargement et d'actualisation.
Fournir des retours d'information à l'utilisateur.: Use the download progress event to show update progress to users.
Nettoyer les écouteurs.: Supprimez les écouteurs d'événements lorsque ceux-ci ne sont plus nécessaires pour éviter les fuites de mémoire.
Tester les scénarios d'actualisation.: Tester divers scénarios d'actualisation, notamment les échecs, les retours en arrière et les mises à jour majeures.

Continuez d'ici les événements.

Si vous utilisez les événements pour planifier le travail de plugin natif, connectez-l’avec Utilisez @capgo/capacitor-mises à jour pour la capacité native dans Utilisez @capgo/capacitor-mises à jour, Répertoire de l'Capgo pour le flux de travail du produit dans Répertoire de l'Capgo, Capacitor Plugins par Capgo pour le détail d'implémentation dans Capacitor Plugins par Capgo, Ajouter ou Mettre à jour les Plugins pour le détail d'implémentation dans Ajouter ou Mettre à jour les Plugins, et Alternatives aux Plugins d'Entreprise Ionic Pour le flux de travail du produit dans les plugins Ionic Enterprise.