イベント

__CAPGO_KEEP_0__のセットアップ用質問をコピーし、インストール手順と完全なマークダウンガイドを含めます。

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：バンドル情報 - ダウンロード可能なアップデートバンドルの情報

`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：バンドル情報 - ダウンロードしたバンドルの情報

`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__CAPGO_KEEP_0__ - ダウンロードに失敗したバージョン

`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__CAPGO_KEEP_0__ - 現在のバンドルに関する情報
status: string - __CAPGO_KEEP_0__

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 __CAPGO_KEEP_1__

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

例：完全な更新フロー

ダウンロードが完了したイベントをハンドリングする例です。

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

ベストプラクティス

常に呼び出す notifyAppReady()自動更新を使用する場合、常にアプリケーションが初期化された後、このメソッドを呼び出すことでロールバックを防ぐことができます。
失敗を柔軟に処理するダウンロードおよび更新の失敗のための適切なエラーハンドリングを実装する
ユーザーにフィードバックを提供するダウンロードの進行状況イベントを使用して、ユーザーにアップデートの進行状況を表示する
リスナーのクリーンアップ: イベントリスナを削除して、メモリリークを防ぎましょう。
テストアップデートシナリオ: 失敗、ロールバック、メジャーアップデートなど、さまざまなアップデートシナリオをテストします。

イベントから続けて

Capgoを使用している場合 イベント Capgoを使用してネイティブプラグインの作業を計画する場合、イベントを @capgo/capacitor-updater @capgo/capacitor-updater Capgo プラグインディレクトリ Capgo プラグインディレクトリ Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, __CAPGO_KEEP_0__ プラグイン __CAPGO_KEEP_1__ プラグインの追加または更新プラグインの追加または更新の実装詳細については、