イベント

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: バンドル情報 - インストールに失敗したバンドルの情報

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 オブジェクト

「BundleInfo Object」セクション

BundleInfo BundleInfo object に含まれる以下のプロパティがあります。

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
}

Where can be: BundleStatus 可能なシナリオです。

• 'success' - Bundle が正常にダウンロードされました
• 'error' - Bundle のダウンロード/インストールに失敗しました
• 'pending' - Bundle が次のバージョンとして設定されることを待っています
• 'downloading' - Bundle が現在ダウンロード中です

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

ここでは、イベントを使用して完全なアップデートフローを処理する方法の例を示します。

注意

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

続きます：イベント

あなたが使用している イベント を使用してネイティブプラグインの作業を計画する場合、 Using @capgo/capacitor-updater Capgoのネイティブ機能のために@capgo/capacitor-アップデーターを使用します。 Capgo プラグインディレクトリ 製品ワークフローにおけるCapgo プラグインディレクトリのために Capacitor プラグイン Capgo Capgoの実装詳細については、Capacitor プラグインによってCapgoで管理されます。 プラグインの追加または更新 プラグインの追加または更新の実装詳細 Ionic Enterpriseプラグインの代替 Ionic Enterpriseプラグインの代替の製品ワークフロー