Événements

L'Capacitor plugin de mise à jour 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 méthode sur l'objet : addListener Coller dans le presse-papier CapacitorUpdater Événements disponibles

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

Sous-section intitulée « téléchargement »

download

Événements disponibles

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

Données d'événement :

• percentNombre - Taux de progression de téléchargement (0-100)
• bundleNote : BundleInfo - Informations sur le bundle téléchargé

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

Section intitulée “pas de mise à jour nécessaire”

noNeedUpdate

Copier dans le presse-papier

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

BundleInfo - Informations sur le bundle actuel

• bundle__CAPGO_KEEP_0__

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 de l'événement :

• bundle: BundleInfo - Informations sur la mise à jour du bundle 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
});

Données de l'é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 d'événement :

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

downloadFailed

Fired when a bundle download has failed.

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 téléchargé avec succès

appReloaded

Fired when the app has been reloaded.

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

Données d'événement : Aucune

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

Données d'événement :

• bundle: BundleInfo - Informations sur le bundle actuel
• status: string - Le statut 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.

Objet BundleInfo

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

Ceci UpdateManager La classe ne comprend pas l'appel requis pour le flux de mise à jour automatique. Veuillez consulter les CapacitorUpdater.notifyAppReady() docs pour plus d'informations sur la mise en place correcte de l'appel notifyAppReady. Pratiques à suivre Pratiques à suivre

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. Toujours appeler notifyAppReady()Lors de l'utilisation de la mise à jour automatique, appelez toujours cette méthode après l'initialisation de votre application pour prévenir le rollback.

2. Gérer les échecs avec tactImplémenter un traitement d'erreur approprié pour les échecs de téléchargement et de mise à jour.

3. Fournir des feedbacks à l'utilisateur: Utilisez l'événement 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 de mise à jour: Testez divers scénarios de mise à jour, notamment les échecs, les retours en arrière et les mises à jour majeures.

Continuez de l'Événement

Si vous utilisez Événements pour planifier le travail de plugin natif, connectez-le avec En utilisant @capgo/capacitor-updater pour la capacité native dans En utilisant @capgo/capacitor-updater, Répertoire de plugins Capgo pour le flux de travail du produit dans le répertoire de plugins 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 de Plugins d'Entreprise Ionic pour le flux de travail du produit dans les alternatives de plugins d'entreprise Ionic