Events

Capgo 更新器插件（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

在 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:

majorAvailable

Section titled “majorAvailable”

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

Copy to clipboard

• version事件数据：

提示

提示

updateFailed

Section titled “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 具有以下属性的对象：

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' - 下载失败
• 'error' - 等待下一个
• 'pending' - 正在下载
• 'downloading' 示例：完整更新流程

标题：示例：完整更新流程

__CAPGO_KEEP_0__

注意

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

从事件继续

如果您正在使用 事件 为了native插件的工作，连接它与 使用@capgo/capacitor-updater 对于native能力在使用@capgo/capacitor-updater, Capgo插件目录 对于产品工作流程在Capgo插件目录, Capacitor插件由Capgo 对于实现细节在Capacitor插件由Capgo, 添加或更新插件 对于实现细节在添加或更新插件,和 Ionic企业插件替代品 对于产品工作流程在Ionic企业插件替代品.