@capgo/capacitor-updater
Live update for capacitor apps.
コルダバとエレクトロンでも利用可能
コルダバとエレクトロンでも利用可能Capgoのリアルタイム更新はCapacitorに限られません。同様のバックエンドとCLIを使用して、以下のクライアントプラグインと共に:
コルダバのアップデーター
コルダバiOS 7+とAndroid 13+用のOTA
Electron アップデーター
Desktop live updates with the same API.
Live update for capacitor apps.
基本機能
セクション「基本機能」notifyAppReady- JavaScriptの初期化が成功したことをネイティブレイヤーに通知する。setUpdateUrl- アプリのアップデートURLを実行時でダイナミックに設定する。setStatsUrl- アプリの統計URLを実行時でダイナミックに設定する。setChannelUrl- アプリのチャンネルURLを実行時でダイナミックに設定する。
Public API
「パブリック 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 | このデバイスにカスタムIDを設定します。 |
listChannels | アプリに保管されているすべてのダウンロード済みバンドルを取得します。 |
setCustomId | アプリを既知の良いバンドルにリセットします。 |
getBuiltinVersion | アプリ内で組み込まれたバンドルのバージョンを取得します (アプリ内で組み込まれたオリジナルのバージョン)。 |
getDeviceId | このデバイスのユニークでプライバシーに優しい識別子を取得します。 |
getPluginVersion | アプリ内でインストールされているCapacitor Updater プラグインのバージョンを取得します。 |
isAutoUpdateEnabled | 自動更新が現在有効かどうかを確認します。 |
removeAllListeners | このプラグインに登録されているすべてのイベントリスナーを削除します。 |
addListener | アプリ内でバンドルのダウンロードイベントをリスンします。ダウンロードが開始されたとき、ダウンロード中、ダウンロードが完了したときに1回だけ発生します。このイベントはダウンロード中の進行度をすべて返します。 |
addListener | 常にアプリが起動されたときに強制的にチェックしたい場合に便利なイベントです。 |
addListener | 常にアプリが起動されたときに強制的にチェックしたい場合に便利なイベントです。 |
addListener | ダウンロードが完了したイベントをリスンします。 |
addListener | バックエンドが現在のアプリと不互換であると判断した場合に発生するアップデートイベントをリスンします。古いリスナーのペイロードと同じです。 majorAvailable バックエンドが現在のアプリと不互換であると判断した場合に発生するメジャーアップデートイベントをリスンします。disableAutoUpdateBreakingを設定するとメジャーアップデートがブロックされます。 |
addListener | メジャーアップデートがブロックされている場合に発生するイベントをリスンします。 |
addListener | アプリ内でアップデート失敗イベントをリスンし、次のアプリ起動時にアップデートのインストールが失敗したことを知らせる。 |
addListener | アプリ内でセットイベントをリスンし、バンドルが成功的に適用されたことを知らせる。このイベントは、JavaScriptが消費するまでネイティブに保持されるため、アプリが再読み込みされる前にリスナーがアタッチされていない場合、最後の pendind イベントはリスナーがサブスクライブしたときに配信される。 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
Section titled “Keep going from @capgo/capacitor-updater”Capacitor Updater Pluginの更新情報を修正したり新機能を追加したりしたい場合はCapacitor Updater PluginのリポジトリにPull Requestを送ることができます。 Keep going from @capgo/capacitor-updater Section titled “Keep going from @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater” Using @capgo/capacitor-updater @capgo/capacitor-updater Capgo Plugin Directory for the product workflow in Capgo Plugin Directory, Capacitor Plugins by Capgo for the implementation detail in Capacitor Plugins by Capgo, プラグインの追加または更新 プラグインの追加または更新の実装詳細について、 Ionic Enterprise プラグインの代替 Ionic Enterprise プラグインの代替の製品ワークフローについて