事件

Capacitor 更新器插件提供了几个事件，您可以监听这些事件来监控更新过程并响应不同状态。

事件监听器设置

要监听事件，请使用 addListener method on the CapacitorUpdater object：

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

在 bundle 下载过程中触发。 提供下载进度信息。

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

事件数据：

• percent: number - 下载进度百分比（0-100）
• bundle: BundleInfo - 下载的 bundle 信息

注意

下载过程中会多次触发此事件以报告进度。

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() 防止自动回滚时，

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' __CAPGO_KEEP_0__
• 'downloading' - 正在下载捆绑包

示例：完整更新流程

以下是处理完整更新流程的事件示例：

注意

请注意 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. 测试更新场景: 测试各种更新场景，包括失败、回滚和重大更新。

继续从 Events

如果您正在使用 Events 来规划原生插件工作，连接它与 使用 @capgo/capacitor-updater 为原生能力在使用 @capgo/capacitor-updater 中 Capgo 插件目录 为产品工作流程在 Capgo 插件目录中 Capacitor 由 Capgo 的插件 为实现细节在 Capacitor 由 Capgo 的插件中 添加或更新插件 关于在添加或更新插件中实现详细信息， Ionic 企业插件替代品 关于Ionic 企业插件替代品的产品工作流程。