Événements

Le plugin de mise à jour Capacitor fournit plusieurs événements auxquels vous pouvez vous abonner 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

Copier dans le presse-papier

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

Section intitulée « Téléchargement »

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

Note

Cet événement se déclenche plusieurs fois pendant le téléchargement pour signaler le progrès.

noNeedUpdate

Déclenché 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);
});

Données de l'événement :

• bundle: BundleInfo - Informations sur le bundle actuel

updateAvailable

Déclenché lorsqu'une nouvelle 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
});

Données d'événement :

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

downloadComplete

Déclenché lorsqu'un téléchargement de bundle est terminé 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
});

Données d'événement :

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

majorAvailable

Déclenché lorsqu'une mise à jour majeure est disponible mais bloquée par les paramètres d'auto-mise à jour.

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

Données d'événement :

• version: string - Le numéro de version de la mise à jour majeure

Conseil

Les mises à jour majeures nécessitent généralement une confirmation de l'utilisateur ou des mises à jour de l'application. Utilisez cet événement pour informer les utilisateurs de manière appropriée.

updateFailed

Déclenché lorsqu'une mise à jour a échoué à s'installer à la prochaine démarrage de l'application.

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

Données de l'événement :

• bundle: BundleInfo - Informations sur le bundle qui a échoué à s'installer

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

Données d'événement :

• version: string - La version qui n'a pas pu être téléchargée

appReloaded

Déclenché lorsqu'il a été rechargé l'application.

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

Données d'événement : Aucune

appReady

Déclenché lorsque l'application est prête à être utilisée après une mise à jour.

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

Données d'événement :

• bundle: BundleInfo - Informations sur le bundle actuel
• status: string - L'état prêt

Attention

N'oubliez pas d'appeler notifyAppReady() dans le délai configuré par défaut (10 secondes) pour empêcher le rollback automatique.

BundleInfo Objet

Beaucoup d'é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' - Le bundle est en attente d'être défini comme le prochain
• 'downloading' - Le bundle est actuellement en cours de téléchargement

Exemple : Flux de mise à jour complet

Voici un exemple de gestion du flux de mise à jour complet avec des événements :

Attention

Ce UpdateManager classe ne comprend pas l'appel requis pour le flux de mise à jour automatique. Veuillez consulter le CapacitorUpdater.notifyAppReady() classe ne comprend pas l'appel requis pour le flux de mise à jour automatique. Veuillez consulter le placer l'app prête pour l'appel docs pour plus d'informations.

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

Meilleures pratiques

1. Appeler toujours notifyAppReady()Lors de l'utilisation de l'auto-mise à jour, appelez toujours cette méthode après que votre application s'initialise pour prévenir le roulage.

2. Gérer les échecs avec éléganceImplémenter une gestion d'erreurs appropriée pour les échecs de téléchargement et de mise à jour.

3. Fournir des retours d'informations à l'utilisateurUtiliser l'événement de progression de téléchargement pour afficher la progression de mise à jour aux utilisateurs.

4. Nettoyer les écouteurs: Supprimez les écouteurs d'événements lorsque ceux-ci ne sont plus nécessaires pour prévenir les fuites de mémoire.

5. Testez les scénarios d'actualisation: Testez divers scénarios d'actualisation, y compris les échecs, les annulations et les mises à jour majeures.