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+ 以上
Cordova Android 13+ および/または Cordova iOS 7+
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
```

クイックスタート

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

よくある落とし穴

このプラグインと cordova-plugin-ionic-webview を併用しないでください。
呼び出す notifyAppReady() バンドルが読み込まれたらすぐに。重い UI 処理でロールバックの猶予が遅れる前に。
Cordova のスキーム設定が正しいことを確認してください。

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

TypeScript の型定義は 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 バンドルリクエストをインターセプトするために実装されています。

最初の bundle をアップロード

Webアセットをビルドし、Capgo CLI でアップロードします（Capacitor と同じワークフロー）：

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

次のステップ

設定を次と比較してください Capacitor updaterの設定 — ほとんどのオプションは plugin.xml 変数に対応しています。
読む Live updateの互換性ネイティブプラグインの変更をリリースする前に。
後で Capacitor へ移行する場合は、同じ Capgo アプリ ID とチャネルを維持してください。変更されるのはクライアントプラグインのパッケージのみです。