メインコンテンツへスキップ

イベント

GitHub

Capacitor Updater プラグインは、更新プロセスの監視や異なる状態への対応のために、リスニング可能な複数のイベントを提供します。

イベントをリッスンするには、 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();

bundleのダウンロード中に発火します。ダウンロードの進捗情報を提供します。

CapacitorUpdater.addListener('download', (event) => {
console.log(`Download progress: ${event.percent}%`);
console.log('Bundle info:', event.bundle);
});

イベントデータ:

  • percent: number - ダウンロード進捗率 (0-100)
  • bundle: BundleInfo - ダウンロード中のバンドルに関する情報

アップデート確認の結果、アップデートが不要と判定されたときに発火します。

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

イベントデータ:

  • bundle: BundleInfo - 現在のバンドルに関する情報

ダウンロード可能な新しいアップデートがあるときに発火します。

CapacitorUpdater.addListener('updateAvailable', (event) => {
console.log('Update available');
console.log('New bundle:', event.bundle);
// You can trigger a download here if needed
});

イベントデータ:

  • bundle: BundleInfo - 利用可能な更新バンドルに関する情報

バンドルのダウンロードが正常に完了したときに発火します。

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 - ダウンロードされたバンドルに関する情報

メジャーアップデートが利用可能だが、自動更新の設定によりブロックされたときに発火します。

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

イベントデータ:

  • version: string - メジャーアップデートのバージョン番号

次のアプリ起動時にアップデートのインストールに失敗した場合に発火します。

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

イベントデータ:

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

バンドルのダウンロードに失敗した場合に発火します。

CapacitorUpdater.addListener('downloadFailed', (event) => {
console.error('Download failed for version:', event.version);
// Handle download retry logic
});

イベントデータ:

  • version: string - ダウンロードに失敗したバージョン

アプリがリロードされたときに発火します。

CapacitorUpdater.addListener('appReloaded', () => {
console.log('App has been reloaded');
// Perform any necessary reinitialization
});

イベントデータ: なし

更新後にアプリが使用可能になったときに発火します。

CapacitorUpdater.addListener('appReady', (event) => {
console.log('App is ready');
console.log('Current bundle:', event.bundle);
console.log('Status:', event.status);
});

イベントデータ:

  • bundle: BundleInfo - 現在のバンドルに関する情報
  • status: string - 準備完了ステータス

多くのイベントには、 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' - 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
}
}
  1. 必ず呼び出すこと notifyAppReady(): auto-update を使用する場合、ロールバックを防ぐためにアプリの初期化後に必ずこのメソッドを呼び出してください。

  2. 失敗を適切に処理する: ダウンロードやアップデートの失敗に対して、適切なエラーハンドリングを実装してください。

  3. ユーザーにフィードバックを表示する: download progress イベントを使用して、アップデートの進捗状況をユーザーに表示してください。

  4. リスナーのクリーンアップ: メモリリークを防ぐため、不要になったイベントリスナーは削除してください。

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

使用している場合 イベント ネイティブプラグインの作業を計画するには、次と連携してください: @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 Capgo プラグインディレクトリ Capgo プラグインディレクトリのプロダクトワークフローについては、 Capgo による Capacitor プラグイン Capgo による Capacitor プラグインの実装詳細については、 プラグインの追加または更新 プラグインの追加または更新における実装詳細については、および Ionic Enterprise プラグインの代替案 Ionic Enterprise プラグインの代替案におけるプロダクトワークフローについては。