使用 Cordova Updater 进行入门

复制一个安装步骤和完整的Markdown指南的设置提示。

        Set up this Capacitor plugin in the project.

Use the package manager already used by the project.
Install these package(s): `@capgo/cordova-updater`
Run the required Capacitor sync/update step after installation.
Read this markdown guide for the full setup steps: https://raw.githubusercontent.com/Cap-go/website/refs/heads/main/apps/docs/src/content/docs/docs/plugins/cordova-updater/getting-started.mdx
Use that guide for platform-specific steps, native file edits, permissions, config changes, imports, and usage setup.
If that guide references other docs pages, read them too.

本指南将指导您添加 @capgo/cordova-updater 到 Cordova 应用程序中，以便您可以在 iOS 和 Android 上接收 Capgo 的实时更新。

标题为“先决条件”

Cordova CLI 12+
安卓 13+ 和/或 iOS 7+ Cordova
一个 Capgo 账户 (capgo.app/register)

安装

从 npm 安装插件，并传递您的 Capgo 应用程序 ID：

cordova plugin add @capgo/cordova-updater --variable APP_ID=YOUR_CAPGO_APP_ID

可选：在安装时覆盖默认值（同 Capacitor 更新器中的变量）：

cordova plugin add @capgo/cordova-updater \
  --variable APP_ID=YOUR_CAPGO_APP_ID \
  --variable DEFAULT_CHANNEL=production \
  --variable UPDATE_URL=https://plugin.capgo.app/updates \
  --variable AUTO_UPDATE=atBackground

更改插件变量后准备本机项目：
终端窗口
```
cordova prepare android ios
```

JavaScript 使用

之后 deviceready, 插件将作为 cordova.plugins.Updater:

document.addEventListener('deviceready', async () => {
  const { Updater } = cordova.plugins;

  await Updater.notifyAppReady();

  const latest = await Updater.getLatest();
  if (latest.url && !latest.error) {
    const bundle = await Updater.download({
      url: latest.url,
      version: latest.version,
      checksum: latest.checksum,
    });

    await Updater.next({ id: bundle.id });
  }
});

类型脚本类型随着npm包一起发布:

import type { UpdaterPlugin } from '@capgo/cordova-updater';

declare const cordova: { plugins: { Updater: UpdaterPlugin } };

需要 Cordova Android 13+ 才能将 WebView 从默认方案中服务。 https://localhost/ 方案。
插件注册一个 CordovaPluginPathHandler 来服务下载的包资产。

需要 Cordova iOS 7+ 以及默认 app://localhost/ 方案。
插件实现 CDVPluginSchemeHandler 拦截包请求。

上传您的第一个包

构建您的 Web 资产，然后使用 Capgo CLI 上传（与 Capacitor 的工作流程相同）：

bun run build
bunx @capgo/cli@latest bundle upload --channel=production

下一步

__CAPGO_KEEP_0__ 升级器配置 Capacitor updater configuration 变量。 plugin.xml 阅读
实时更新兼容性在发布本机插件更改之前阅读。迁移到 __CAPGO_KEEP_0__ 后？保持相同的 __CAPGO_KEEP_1__ 应用 ID 和频道；仅客户端插件包发生变化。
Migrating to Capacitor later? Keep the same Capgo app ID and channels; only the client plugin package changes.