イベント

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

Available Events

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

majorAvailable

majorAvailable

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

Event Data:

• versionstring - __CAPGO_KEEP_0__

Capacitor

Major updates typically require user confirmation or app store updates. Use this event to notify users appropriately.

updateFailed

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 - 準備完了の状態

注意

呼び出すことを忘れないでください notifyAppReady() 自動ロールバックを防ぐために、デフォルト 10 秒のタイムアウト内に呼び出すことを忘れないでください

BundleInfo オブジェクト

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

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
}

__CAPGO_KEEP_1__ BundleStatus は次のいずれかになります:

• 'success' - ダウンロードが正常に完了しました
• 'error' - ダウンロード/インストールが失敗しました
• '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. __CAPGO_KEEP_0__ notifyAppReady()__CAPGO_KEEP_0__

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

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

4. リスナーのクリーンアップ: メモリリークを防ぐために、リスナーが必要なくなったら削除する。

5. アップデートのシナリオをテストする: 失敗、ロールバック、およびメジャーアップデートを含むさまざまなアップデートシナリオをテストする。

イベントから続ける

あなたが使用している場合 イベント ネイティブ プラグインの作業を計画するには、接続する Using @capgo/capacitor-updater ネイティブ機能のために Using @capgo/capacitor-updater を使用する Capgo プラグイン ディレクトリ Capgo プラグイン ディレクトリの製品ワークフロー Capacitor プラグイン ( Capgo によって提供 ) Capacitor プラグイン ( Capgo によって提供 ) の実装詳細 プラグインの追加または更新 プラグインの追加または更新の実装詳細 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフロー