イベント

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

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

イベントを聴くには、オブジェクトの addListener method 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 - 準備完了の状態

注意

自動ロールバックを防ぐために、 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 - Bundle が正常にダウンロードされました

• 'success' - Bundle のダウンロード/インストールに失敗しました
• 'error' - Bundle が次のものとして設定されることを待っています
• 'pending' - Bundle が現在ダウンロード中です
• 'downloading' 例: 完全なアップデートフロー

「例: 完全なアップデートフロー」のセクション

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

注意

この UpdateManager クラスには、自動更新フローで必要な CapacitorUpdater.notifyAppReady() 呼び出しを含んでいません。 詳細は notifyAppReadyを正しく配置する docsを参照してください。

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

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

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

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

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