Eventi

Il plugin di aggiornamento Capacitor fornisce diversi eventi che puoi ascoltare per monitorare il processo di aggiornamento e rispondere a diversi stati.

Impostazione dell'ascoltatore di eventi

Per ascoltare gli eventi, utilizza il addListener metodo sul CapacitorUpdater oggetto:

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

Eventi disponibili

download

Avviato durante il processo di download del pacchetto. Fornisce informazioni sul progresso del download.

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

Dati evento:

• percent: numero - Percentuale di progresso del download (0-100)
• bundle: BundleInfo - Informazioni sul pacchetto in corso di download

Nota

Questo evento si avvia più volte durante il download per riferire il progresso.

noNeedUpdate

Avviato quando un controllo per gli aggiornamenti determina che non è necessario un aggiornamento.

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

Dati evento:

• bundle: BundleInfo - Informazioni sul bundle corrente

updateAvailable

Emitto quando è disponibile un nuovo aggiornamento per il download.

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

Dati evento:

• bundle: BundleInfo - Informazioni sul bundle di aggiornamento disponibile

downloadComplete

Emitto quando il download del bundle è stato completato con successo.

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

Dati evento:

• bundle: Informazioni sul bundle scaricato

majorAvailable

Triggersi quando è disponibile un aggiornamento maggiore ma è bloccato dalle impostazioni di aggiornamento automatico.

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

Dati evento:

• version: string - Il numero di versione dell'aggiornamento maggiore

Suggerimento

Gli aggiornamenti maggiori richiedono spesso la conferma dell'utente o gli aggiornamenti dell'app store. Utilizza questo evento per informare gli utenti in modo appropriato.

updateFailed

Triggersi quando un aggiornamento non riesce ad installarsi alla prossima avviamento dell'app.

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

Dati dell'evento:

• bundle: BundleInfo - Informazioni sul bundle che non è stato installato correttamente

downloadFailed

Emitto quando il download di un bundle ha avuto esito negativo.

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

Dati dell'evento:

• version: string - La versione che non è stata scaricata

appReloaded

Emitto quando l'app è stata riavviata.

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

Dati dell'evento: Nessuna

appReady

Eseguito quando l'app è pronta all'uso dopo un aggiornamento.

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

Dati evento:

• bundle: Informazioni sul bundle corrente -
• status: stringa - Lo stato di pronto

Attenzione

Ricorda di chiamare notifyAppReady() entro il timeout configurato (predefinito 10 secondi) per evitare il rollback automatico.

Oggetto BundleInfo

Molti eventi includono un BundleInfo oggetto con le seguenti proprietà:

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
}

Dove BundleStatus può essere:

• 'success' - Bundle scaricato con successo
• 'error' - Scaricamento/installazione del bundle fallito
• 'pending' - Bundle in attesa di essere impostato come successivo
• 'downloading' - Bundle in corso di download

Esempio: Flusso di aggiornamento completo

Ecco un esempio di gestione del flusso di aggiornamento completo con eventi:

Attenzione

Questo UpdateManager la classe non include il CapacitorUpdater.notifyAppReady() chiamata richiesta per il flusso di aggiornamento automatico. Per ulteriori informazioni, consultare il per informazioni sul posizionamento della chiamata notifyAppReady documento per ulteriori informazioni.

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

Pratiche raccomandate

1. Sii sempre sicuro di chiamare notifyAppReady(): Quando si utilizza l'aggiornamento automatico, assicurati di chiamare questo metodo dopo l'inizializzazione dell'applicazione per prevenire il rollback.

2. Gestisci le fallite con grazia: Implementa un corretto gestione degli errori per le fallite di download e aggiornamento.

3. Fornisci feedback all'utente: Utilizza l'evento di progresso di download per mostrare l'aggiornamento in corso agli utenti.

4. Pulisci gli ascoltatori: Rimuovi gli ascoltatori degli eventi quando non sono più necessari per prevenire le falle di memoria.

5. Testa gli scenari di aggiornamento: Testa vari scenari di aggiornamento, inclusi fallite, annullamenti e aggiornamenti principali.