Event

The Capacitor Plugin Pembaruan menyediakan beberapa event yang dapat Anda dengarkan untuk memantau proses pembaruan dan bereaksi terhadap berbagai keadaan.

Pengaturan Pembaruan Pemangku Jasa

Untuk mendengarkan event, gunakan addListener metode pada objek: CapacitorUpdater object:

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

Bab berjudul “Event yang Tersedia”

download

Dibebaskan selama proses download bundle. Memberikan informasi tentang kemajuan download.

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

Data Acara:

• percent: angka - Persentase kemajuan download (0-100)
• bundle: BundleInfo - Informasi tentang bundle yang sedang diunduh

Catatan

Acara ini melepaskan beberapa kali selama download untuk melaporkan kemajuan.

noNeedUpdate

Dibebaskan ketika cek update menentukan bahwa tidak ada update yang diperlukan.

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

Data Acara:

• bundle: Info Paket - Informasi tentang paket saat ini

updateAvailable

Ditetapkan ketika ada pembaruan baru yang tersedia untuk diunduh.

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

Data Acara:

• bundle: Info Paket - Informasi tentang paket pembaruan yang tersedia

downloadComplete

Ditetapkan ketika pengunduhan paket telah selesai dengan sukses.

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

Data Acara:

• bundle: Info Paket - Informasi tentang paket yang diunduh

majorAvailable

Diajukan ketika ada pembaruan besar tersedia tetapi diblokir oleh pengaturan auto-update.

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

Data Acara:

• version: string - Nomor versi pembaruan besar

Tip

Pembaruan besar biasanya memerlukan konfirmasi pengguna atau pembaruan toko aplikasi. Gunakan acara ini untuk memberitahu pengguna dengan tepat.

updateFailed

Diajukan ketika pembaruan gagal terpasang pada aplikasi mulai berikutnya.

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

Data Acara:

• bundle: Informasi Paket - Informasi tentang paket yang gagal terinstal

downloadFailed

Dipicu ketika pengunduhan paket gagal.

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

Data Acara:

• version: string - Versi yang gagal diunduh

appReloaded

Dipicu ketika aplikasi telah di-reload.

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

Data Acara: Tidak ada

appReady

Diaktifkan ketika aplikasi siap digunakan setelah diperbarui.

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

Data Acara:

• bundle: BundleInfo - Informasi tentang bundle saat ini
• status: string - Status siap

Peringatan

Ingatlah untuk memanggil notifyAppReady() dalam waktu yang ditentukan (default 10 detik) untuk mencegah rollback otomatis.

Objek BundleInfo

Banyak acara termasuk BundleInfo objek dengan sifat-sifat berikut:

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
}

Dimana BundleStatus bisa:

• 'success' - Paket yang diunduh berhasil
• 'error' - Pengunduhan/penginstalan paket gagal
• 'pending' - Paket yang akan dijadikan versi berikutnya
• 'downloading' - Saat ini bundle sedang diunduh

Contoh: Alur Pembaruan Lengkap

Contoh penggunaan alur pembaruan lengkap dengan menggunakan event:

Hatihati

This UpdateManager kelas tidak termasuk dalam CapacitorUpdater.notifyAppReady() mengenai cara memasang panggilan notifyAppReady dengan benar docs untuk informasi lebih lanjut. Baca lebih lanjut untuk informasi lebih lanjut.

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

Bab berjudul “Praktik Terbaik”

1. Selalu panggil notifyAppReady()Jika menggunakan auto-update, selalu panggil metode ini setelah aplikasi Anda diinisialisasi untuk mencegah rollback.

2. Tangani gagal dengan sopanImplementkan penanganan kesalahan yang tepat untuk gagal download dan update.

3. Berikan feedback kepada pengguna.Gunakan event kemajuan download untuk menampilkan kemajuan update kepada pengguna.

4. Membersihkan penggunaan listener.Hapus penggunaan listener ketika tidak lagi diperlukan untuk mencegah kebocoran memori.

5. Uji skenario update.Uji berbagai skenario update termasuk gagal, rollback, dan update besar.

Teruskan dari Events.

Jika Anda menggunakan Events untuk merencanakan pekerjaan plugin native, hubungkannya dengan Gunakan @capgo/capacitor-updater untuk kemampuan asli di Gunakan @capgo/capacitor-updater, Capgo Direktori Plugin untuk alur kerja produk di Capgo Direktori Plugin, Capacitor Plugin oleh Capgo untuk detail implementasi di Capacitor Plugin oleh Capgo, Menambahkan atau Mengupdate Plugin untuk detail implementasi di Menambahkan atau Mengupdate Plugin, dan Alternatif Plugin Enterprise Ionic untuk alur kerja produk di Alternatif Plugin Enterprise Ionic.