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のLive Updateを受け取れるようになります。

前提条件

Cordova CLI 12+
Cordova Android 13+ および/または Cordova iOS 7+
Capgo アカウント（capgo.app/register)

インストール

npm からプラグインをインストールし、Capgo の app ID を渡します：
ターミナルウィンドウ
```
cordova plugin add @capgo/cordova-updater --variable APP_ID=YOUR_CAPGO_APP_ID
```

任意：インストール時にデフォルト値を上書きする（Capacitor updater と同じ変数を使用）：

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

プラグインの変数を変更した後は、native プロジェクトを準備してください：
ターミナルウィンドウ
```
cordova prepare android ios
```

クイックスタート

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

よくある落とし穴

このプラグインを使用する場合、cordova-plugin-ionic-webview は使用しないでください。
呼び出す notifyAppReady() 重いUI処理によってロールバックの猶予期間が遅れる前に、バンドルがロードされた直後に実行してください。
Cordova の scheme 設定を正しく維持してください。

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 パッケージに TypeScript の型定義が含まれています：

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

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

WebView がデフォルトのスキームで提供されるため、Cordova Android 13 以上が必要です。 https://localhost/ 。
プラグインは以下を登録します： CordovaPluginPathHandler ダウンロードしたbundleアセットを配信するために使用します。

デフォルトのschemeを使用する app://localhost/ scheme.
このプラグインは、 CDVPluginSchemeHandler bundleリクエストをインターセプトするために実装されています。

最初のbundleをアップロードする

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

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

次のステップ

設定を以下と比較してください： Capacitor updater の設定 — ほとんどのオプションは plugin.xml 変数に対応しています。
Read Live update との互換性をリリースする前に確認してください。
後で Capacitor へ移行する場合も、Capgo の App ID とチャンネルはそのまま維持できます。変更が必要なのはクライアントプラグインのパッケージのみです。