Capacitor UpdaterのGetting Started

このプラグインのインストール手順とフルマークダウンガイドをコピーします。

        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.

このガイドでは、iOSとAndroidでリアルタイム更新を受けるために @capgo/cordova-updater to a Cordova app so you can receive Capgo live updates on iOS and Android.

「前提条件」のセクション

Cordova CLI 12+
アカウント (
Capgo.app/registercapgo.app/register)

「インストール」のセクション

Install the plugin from npm and pass your Capgo app 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 パッケージには TypeScript の型が含まれています。

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

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

Cordova Android 13+ を使用する必要があり、デフォルトのスキームから WebView を提供します。 https://localhost/ プラグインはダウンロードしたバンドルアセットを提供するために、
Cordova iOS 7+ を使用する必要があり、デフォルトのスキームから提供します。 CordovaPluginPathHandler ダウンロードしたバンドルアセットを提供するために

デフォルトのスキームから app://localhost/ スキーム。
プラグインは CDVPluginSchemeHandler をキャッチするために

最初のバンドルをアップロードしてください

CapgoとCLIを使用して、Capacitorと同じワークフローで、Webアセットをビルドし、CapgoとCLIをアップロードしてください。

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

次のステップ

__CAPGO_KEEP_0__のアップデート設定と比較してください Capacitor — 最大のオプションは変数にマップされます。 plugin.xml 変数。
読むライブ更新の互換性 __CAPGO_KEEP_0__ の変更を出荷する前に。
Capacitor への移行は後で行う場合、同じ Capgo アプリ ID とチャンネルを維持し、クライアントプラグインパッケージのみが変更されます。