@capgo/capacitor-updater

CordovaおよびElectronでも利用可能

Capgoのリアルタイム更新はCapacitorに限られません。同様のバックエンドとCLIを使用して、同系列のクライアントプラグインと共に:

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

Electronのアップデート APIのデスクトップライブアップデート

概要

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

主な機能

• notifyAppReady - JavaScriptの初期化が成功したことをネイティブレイヤーに通知する。
• setUpdateUrl - アプリのアップデートURLを実行時動的に設定する。
• setStatsUrl - アプリの統計URLを実行時動的に設定する。
• setChannelUrl - アプリのチャンネルURLを実行時動的に設定する。

パブリックAPI

メソッド	説明
notifyAppReady	JavaScriptの初期化が成功したことをネイティブ層に通知します。
setUpdateUrl	アプリの更新URLを実行時動的に設定します。
setStatsUrl	アプリの統計URLを実行時動的に設定します。
setChannelUrl	アプリのチャンネルURLを実行時動的に設定します。
download	指定されたURLから新しいバンドルをダウンロードし、後でインストールします。
next	アプリがバックグラウンドまたは再起動したときに、次にアクティブ化するバンドルを設定します。
set	アプリの現在のバンドルを設定し、すぐにアプリをリロードします。
delete	ローカルストレージからバンドルを削除してディスクスペースを確保します。
setBundleError	手動更新モードで、バンドルをエラーとしてマークします。
list	__CAPGO_KEEP_0__
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	このデバイスのユニークでプライバシーに優しいIDを取得します。
getPluginVersion	Capacitor アップデート プラグインのインストールされているアプリのバージョンを取得します。
isAutoUpdateEnabled	自動アップデートが現在有効かどうかを確認します。
removeAllListeners	このプラグインに登録されているすべてのイベントリスナーを削除します。
addListener	アプリ内でバンドルダウンロードイベントをリスンします。ダウンロードが開始されたとき、ダウンロード中、ダウンロードが完了したときに発火します。このイベントはダウンロード中の進行度をすべて返します。
addListener	常にアプリが起動されたときに強制的にチェックしたい場合に便利です。
addListener	常にアプリが起動されたときに強制的にチェックしたい場合に便利です。
addListener	ダウンロードが完了したイベントをリスンします。
addListener	バックエンドが現在のアプリと不互換であると判断した場合にアップデートをブロックする設定でdisableAutoUpdateBreakingを設定した場合に発火します。 majorAvailable バックエンドが現在のアプリと不互換であると判断した場合にアップデートをブロックする設定でdisableAutoUpdateBreakingを設定した場合に発火します。
addListener	メジャーアップデートイベントをリスンします。メジャーアップデートがdisableAutoUpdateBreakingでブロックされている場合に発火します。
addListener	アプリでアップデート失敗イベントをリスンし、次のアプリ起動時にはアップデートがインストールに失敗したことを知らせる。
addListener	アプリでセットイベントをリスンし、バンドルが成功で適用されたことを知らせる。このイベントは、JavaScriptが消費するまでネイティブに保持されるため、アプリが再読み込みされる前にリスナーがアタッチされていない場合、最後の保留中のイベントはリスナーがサブスクライブしたときに配信される。 set アプリでセット次イベントをリスンし、次にインストールされるバンドルのキューがキューされたことを知らせる。
addListener	アプリでダウンロード失敗イベントをリスンし、バンドルのダウンロードが失敗したことを知らせる。
addListener	アプリでリロードイベントをリスンし、リロードが発生したことを知らせる。
addListener	アプリでアプリリードイベントをリスンし、アプリが使用可能になったことを知らせる。このイベントは、JavaScriptが消費するまでネイティブに保持されるため、再読み込みが発生してもリスナーがアタッチされても配信される。
addListener	チャネルプライベートイベントをリスンし、デバイス自律割り当てが許可されていないチャネルを設定しようとしたときに発生する。
addListener	Androidでフレキシブルアップデートの状態が変化したときにリスンする。
addListener	自動アップデート機能が利用可能かどうかを確認する (カスタムサーバー設定によって無効にされていない)。
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で柔軟なインストールアップデートを完了します。

ソースオブトゥルス

This reference is synced from src/definitions.ts in capacitor-updater.

Keep going from @capgo/capacitor-updater

Capacitorのアップデートプラグインを使用している場合 @capgo/capacitor-updater Appflowへの移行のステップ1 Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo CapacitorプラグインのCapgo プラグインの追加または更新 プラグインの追加または更新の実装詳細については Ionic Enterprise プラグインの代替 Ionic Enterprise プラグイン代替の製品ワークフローについては