メニューに進む

@capgo/capacitor-updater

capacitor アプリのライブ更新

CordovaおよびElectronでも利用可能

CordovaおよびElectronでも利用可能

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

capacitor アプリ向けのリアルタイム更新

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

このリファレンスはSync されています。 src/definitions.ts in capacitor-updater.

Capgoを使用している場合 capgo/capacitor-updater Capgoを使用してネイティブプラグインの作業を計画する場合、__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updaterを接続する Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Capgo プラグイン ディレクトリ for the product workflow in Capgo Plugin Directory, Capacitor プラグインのCapgo Capacitor プラグインの実装詳細については、Capgo で確認してください。 プラグインの追加または更新 __CAPGO_KEEP_0__ プラグインの実装詳細については、プラグインの追加または更新、 Capacitor エンタープライズ プラグインの代替 Capacitor エンタープライズ プラグインの製品ワークフローについては、Capacitor エンタープライズ プラグインの代替を参照してください。