イベント

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)
• bundle:BundleInfo - ダウンロード中のバンドルの情報

注意

ダウンロードの進行状況を複数回報告するため、このイベントは複数回発生します。

noNeedUpdate

アップデートのチェックがアップデートが必要ないことを決定した場合に発生します。

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

イベントデータ:

• bundle: BundleInfo - 現在のバンドルの情報

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: string - メジャーアップデートのバージョン番号

ヒント

メジャーアップデートは通常、ユーザーの確認またはアプリストアの更新が必要です。このイベントを使用して、ユーザーに適切な通知を送信します。

updateFailed

アップデートがインストールに失敗した場合に発生します。

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

イベントデータ:

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

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: string - 準備完了のステータス

注意

自動ロールバックを防止するために、有効なタイムアウト (デフォルト 10 秒) 内に呼び出すことを忘れないでください。 notifyAppReady() BundleInfo オブジェクト

Section titled “BundleInfo Object”

多くのイベントには 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. アップデートのシナリオのテスト: 失敗、ロールバック、メジャーアップデートなど、さまざまなアップデートシナリオをテストする

ここから続くイベント

あなたは Events native プラグインの作業を計画するには、接続する Using @capgo/capacitor-updater native 能力のために Using @capgo/capacitor-updater Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリのために Capacitor プラグイン by Capgo Capacitor プラグイン by Capgoの実装詳細 プラグインの追加または更新 プラグインの追加または更新の実装詳細、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品フロー