@capgo/capacitor-アップデーター

capacitorアプリのライブアップデート

始めましょう GitHub

CordovaおよびElectronでも利用可能

CapgoライブアップデートはCapacitorに限られません。同様のバックエンドとCLIを使用して、兄弟クライアントプラグインで:

Cordovaアップデーター Cordova iOS 7+およびAndroid 13+向けのOTA

Electronアップデーター同様のAPIでデスクトップライブアップデート

Overview

Live update for capacitor apps.

Core Capabilities

notifyAppReady - Notify the native layer that JavaScript initialized successfully.
setUpdateUrl - Set the update URL for the app dynamically at runtime.
setStatsUrl - Set the statistics URL for the app dynamically at runtime.
setChannelUrl - Set the channel URL for the app dynamically at runtime.

Public API

Method	Description
`notifyAppReady`	JavaScriptの初期化が成功したことをネイティブレイヤーに通知する。
`setUpdateUrl`	アプリの更新URLを実行時動的に設定する。
`setStatsUrl`	アプリの統計URLを実行時動的に設定する。
`setChannelUrl`	アプリのチャンネルURLを実行時動的に設定する。
`download`	後日インストールするために提供されたURLから新しいバンドルをダウンロードする。
`next`	アプリがバックグラウンドまたは再起動したときにアクティブにする次のバンドルを設定する。
`set`	現在のバンドルを設定し、すぐにアプリをリロードする。
`delete`	ローカルストレージからバンドルを削除してディスクスペースを解放する。
`setBundleError`	手動更新モードでバンドルをエラー/失敗としてマークする。
`list`	アプリ内に保存されているすべてのローカルダウンロードバンドルを取得する。
`reset`	アプリを知られている良いバンドルにリセットする。
`current`	現在のバンドルに関する情報を取得します。
`reload`	適用される更新を手動で再読み込みしてください。
`setMultiDelay`	適用される更新の保留中の条件を設定してください。
`cancelDelay`	すべての遅延条件をキャンセルして、保留中の更新を即座に適用してください。
`getLatest`	最新のバンドルバージョンを確認するために、更新サーバーに問い合わせてください。
`setChannel`	Set a local runtime update channel for this device. It does not create a dashboard/API device override.
`unsetChannel`	デバイスのチャンネル割り当てを削除して、デフォルトのチャンネルに戻してください。
`getChannel`	このデバイスに割り当てられている現在のチャンネルを取得してください。
`listChannels`	このデバイスが自ら割り当てることができるすべてのチャンネルのリストを取得してください。
`setCustomId`	このデバイスに独自の識別子を設定してください。
`getBuiltinVersion`	組み込みのバンドルバージョン (あなたのネイティブアプリに含まれている元のバージョン) を取得してください。
`getDeviceId`	プライバシーに配慮した独自の識別子を取得してください。
`getPluginVersion`	アプリにインストールされているCapacitor Updater プラグインのバージョンを取得します。
`isAutoUpdateEnabled`	自動更新が現在有効かどうかを確認します。
`removeAllListeners`	このプラグインに登録されているすべてのイベントリスナーを削除します。
`addListener`	アプリでバンドルダウンロードイベントをリスンします。ダウンロードが開始されたとき、ダウンロード中、ダウンロードが完了したときに発火します。このイベントはダウンロード中の進行度をすべて返します。
`addListener`	更新が必要ないときに発火します。毎回アプリが起動したときに強制的に更新を確認したい場合に便利です。
`addListener`	更新が利用できるときに発火します。毎回アプリが起動したときに強制的に更新を確認したい場合に便利です。
`addListener`	ダウンロードが完了したときに発火します。
`addListener`	バックエンドが現在のアプリと不相応と判断したときに更新が行われることを検知します。レガシ modalリスナーと同じペイロードを発行します。 `majorAvailable` メジャーアップデートがアプリでブロックされているときに発火します。
`addListener`	アップデートが失敗したときに発火します。
`addListener`	アプリでバンドルが成功したときに発火します。このイベントは、JavaScriptが消費するまでネイティブに保持されるため、アプリが再起動する前にリスナーがアタッチされていない場合、最後の保留中のイベントが保持されます。
`addListener`	__CAPGO_KEEP_0__ `set` イベントはリスナーがサブスクライブしたときに1度だけ配信されます。
`addListener`	アプリ内でセットした次のイベントをリスンし、バンドルがインストールされる直前に通知されます。
`addListener`	アプリ内でダウンロード失敗イベントをリスンし、バンドルダウンロードが失敗したときに通知されます。
`addListener`	アプリ内でリロードイベントをリスンし、リロードが発生したときに通知されます。
`addListener`	アプリ内でアプリが利用可能になったイベントをリスンし、アプリが利用可能になったときに通知されます。このイベントは、JavaScriptが消費するまでネイティブに保持されるため、リスナーがアプリ起動の後半に追加されても、リロード後もまだ配信されることができます。
`addListener`	チャンネルプライベートイベントをリスンし、デバイス自律割り当てが許可されていないチャンネルに設定しようとしたときに発生します。
`addListener`	Android上でフレキシブルアップデートの状態が変化したときにリスンします。
`isAutoUpdateAvailable`	カスタムサーバー設定によって自動アップデート機能が無効化されていないかどうかを確認します。
`getNextBundle`	次のリロードでアクティブ化されるバンドルの情報を取得します。
`getFailedUpdate`	最近のバンドルがロードに失敗したときの情報を取得します。
`setShakeMenu`	デバッグとテスト用にシェイクジェスチャーメニューを有効または無効にします。
`isShakeMenuEnabled`	現在、シェイクジェスチャーデバッグメニューが有効かどうかを確認します。
`setShakeChannelSelector`	動的チャネルセレクタを実行時で有効/無効にする。
`isShakeChannelSelectorEnabled`	動的チャネルセレクタが現在有効かどうかを確認する。
`getAppId`	現在のアップデートサーバー通信用に設定されているApp IDを取得する。
`setAppId`	アップデートサーバー通信用に設定されているApp IDを動的に変更する。
`getAppUpdateInfo`	アプリのApp StoreまたはPlay Storeでの利用可能性に関する情報を取得する。
`openAppStore`	アプリのApp StoreまたはPlay Storeのページを開く。
`performImmediateUpdate`	Androidで即時インアプリアップデートを実行する。
`startFlexibleUpdate`	Androidで柔軟なインアプリアップデートを開始する。
`completeFlexibleUpdate`	Androidで柔軟なインアプリアップデートを完了する。

真実の源

このリファレンスはSyncdから同期されている src/definitions.ts in capacitor-updater.

Keep going from @capgo/capacitor-updater

Capgoを使用している場合 capgo/capacitor-updater Capgoを使用してネイティブプラグインの作業を計画する場合、__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updaterを__CAPGO_KEEP_2__に接続します。 Capgoを使用してネイティブ機能を__CAPGO_KEEP_2__で使用する場合、capgo/capacitor-updaterを__CAPGO_KEEP_2__で使用します。 for the native capability in Using @capgo/capacitor-updater, Capgoを使用して製品ワークフローをCapgo プラグインディレクトリで管理する場合、Capgo プラグインディレクトリを使用します。 Capgo by __CAPGO_KEEP_1__ CapacitorはCapgoによって提供されています。 Capacitor プラグインの実装詳細については、Capgo を参照してください。プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの実装詳細についてはプラグインの追加または更新、 Capacitor Enterprise プラグインの代替 Capacitor Enterprise プラグインの製品ワークフローについて