__CAPGO_KEEP_3__

Capacitor アップデート プラグインは、更新プロセスを監視し、異なる状態に対応するためにリスンすることができるいくつかのイベントを提供します。

イベントリスナーセットアップ

イベントを聞くには、 addListener メソッドを使用します。 CapacitorUpdater オブジェクト:

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

利用可能なイベント

download

バンドルダウンロードプロセス中に発生します。ダウンロードの進行状況情報を提供します。

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

イベントデータ：

• percent数値 - ダウンロード進捗率 (0-100)
• bundleBundleInfo - ダウンロード中のバンドルの情報

注意

ダウンロード中に複数回発生するイベント。進捗状況を報告する。

noNeedUpdate

更新チェックが必要ないことを判断したときに発生する。

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

イベントデータ:

• bundleBundleInfo - 現在のバンドルの情報

updateAvailable

ダウンロード可能な新しい更新が存在するときに発生する。

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

イベントデータ：

• bundle: BundleInfo - ダウンロード可能なアップデート バンドルの情報

downloadComplete

バンドルのダウンロードが正常に完了したときに発火します。

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

イベントデータ：

• bundle: BundleInfo - ダウンロードしたバンドルの情報

majorAvailable

メジャーアップデートが利用可能ですが、自動更新設定によってブロックされています。

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

イベントデータ：

• versionバージョン番号 - メジャーアップデートのバージョン番号

ヒント

メジャーアップデートは通常、ユーザーの確認またはアプリストアのアップデートが必要です。ユーザーに適切に通知するために、このイベントを使用してください。

updateFailed

アプリ起動時にインストールに失敗した場合に発生します。

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

イベントデータ：

• bundleBundleInfo - インストールに失敗したバンドルの情報

downloadFailed

バンドルのダウンロードに失敗した場合に発生します。

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

イベントデータ：

• version: string - ダウンロードに失敗したバージョン

appReloaded

アプリが再読み込みされたときに発火します。

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

イベントデータ： なし

appReady

アプリが更新後使用可能になったときに発火します。

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

イベントデータ：

• bundle: BundleInfo - 現在のバンドルの情報
• status: __CAPGO_KEEP_0__ - __CAPGO_KEEP_0__ の状態

注意

自動ロールバックを防ぐために、10秒以内に notifyAppReady() 自動ロールバックを防ぐために、10秒以内に

BundleInfo オブジェクト

多くのイベントには、 BundleInfo 以下のプロパティを持つオブジェクトが含まれています:

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
}

「」 BundleStatus は、

• 'success' - ダウンロードが正常に完了しました
• 'error' - ダウンロード/インストールが失敗しました
• 'pending' - 次にセットするバンドルが準備中です
• 'downloading' - バンドルが現在ダウンロード中です

例: 完全なアップデートフロー

イベントを処理するための完全なアップデートフローの例があります。

注意

この UpdateManager クラスには、自動アップデートフローに必要な呼び出しを含んでいません。 詳細は、 CapacitorUpdater.notifyAppReady() クラスには、自動アップデートフローに必要な呼び出しを含んでいません。 詳細は、 notifyAppReady を正しく呼び出す 詳細はドキュメントを参照してください。

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

ベストプラクティス

1. 常に呼び出す notifyAppReady()自動更新を使用する場合、このメソッドをアプリケーションが初期化された後には常に呼び出すことでロールバックを防止します。

2. 失敗を柔軟に処理する: ダウンロードと更新の失敗のための適切なエラーハンドリングを実装します。

3. ユーザーにフィードバックを提供する: ダウンロードの進行状況イベントを使用して、ユーザーにアップデートの進行状況を表示します。

4. リスナーのクリーンアップイベントリスナを必要なくなったら削除してメモリリークを防ぎましょう。

5. テストアップデートシナリオ失敗、ロールバック、メジャーアップデートなど、さまざまなアップデートシナリオをテストしてみましょう。