設定
インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。
アップデートシステムをより細かく制御するには、以下の設定で構成できます:
独自のホスト名を使用するには、 updateUrl, statsUrlや channelUrl次を参照してください: Custom Domain の設定.
allowModifyUrl
「allowModifyUrl」セクションJavaScript 側から updateUrl、statsUrl、channelUrl を動的に変更できるようにします。
Android、iOS、Electron で利用可能です。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "allowModifyUrl": true } }}appId
「appId」セクション設定ファイルでアプリの app id を設定します。
Android、iOS、Electron で利用可能です。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "appId": "com.example.app" } }}appReadyTimeout
「appReadyTimeout」セクションネイティブプラグインが更新を「失敗」と判断する前に待機するミリ秒数を設定します。
Android、iOS、Electron で利用可能です。
デフォルト: 10000 (10秒)
{ "plugins": { "CapacitorUpdater": { "appReadyTimeout": 1000 } }}autoDeleteFailed
「autoDeleteFailed」セクションアップデートに失敗したbundleを自動的に削除するかどうかを設定します。
Android、iOS、Electron で利用可能です。
デフォルト: true
{ "plugins": { "CapacitorUpdater": { "autoDeleteFailed": false } }}autoDeletePrevious
「autoDeletePrevious」セクションアップデート成功後、古いbundleを自動的に削除するかどうかを設定します。
Android、iOS、Electron で利用可能です。
デフォルト: true
{ "plugins": { "CapacitorUpdater": { "autoDeletePrevious": false } }}autoSplashscreen
「autoSplashscreen」セクション即時適用モードを使用する場合に必須(
"atInstall","onLaunch"、または"always")、非推奨のdirectUpdate値を含む。インストールし、@capacitor/splash-screen設定してくださいlaunchAutoHide: false。 有効にすると、アップデートの適用後、またはアップデートが不要な場合に、プラグインがスプラッシュスクリーンを非表示にします。 これにより、appReady イベントを手動でリッスンして SplashScreen.hide() を呼び出す必要がなくなります。
Android と iOS で利用できます。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall", "autoSplashscreen": true }, "SplashScreen": { "launchAutoHide": false } }}autoUpdate
「autoUpdate」セクションプラグインが Live Update を確認、ダウンロード、適用する方法を設定します。 アプリがフォアグラウンドに移行したときと、アプリが開いている間は一定の間隔で更新を確認します。
periodCheckDelayそのタイマー間隔を制御します。 後方互換性のため、Boolean 値も引き続きサポートされています:trueは次と同じです"atBackground"とfalseは次と同じです"off"。 String 値を指定すると、以前の Auto Update と Direct Update の設定がマージされます。
オプション:
"off"またはfalse:自動更新チェックを無効にする"atBackground"またはtrue:フォアグラウンド時のチェックごとに自動で確認・ダウンロードし、次にアプリがバックグラウンドに移行したときに更新を適用する"atInstall": 新規インストールまたはネイティブアプリのストア更新直後のみ即時適用します。それ以外の場合は"atBackground"の動作を使用します"onLaunch": アプリがキルされた状態からフォアグラウンドに復帰したとき(コールドスタート)にのみ即時適用します。最初のチェック以降はフォールバックします"atBackground"の動作を使用します"always": フォアグラウンド移行のたびにチェックを行い、アップデートがあれば即時適用します"onlyDownload": 自動的にチェックとダウンロードを行い、emit しupdateAvailable、次のbundleの設定やアップデートの自動適用は行いません
即時適用モード ("atInstall", "onLaunch", "always") はユーザーが待機している間に適用されます。アップロード時は npx @capgo/cli@latest bundle upload --delta 変更されたファイルのみがダウンロードされるようにします。zip全体のアップロードはユーザー体験を低下させます。AndroidとiOSでは、これらのモードには autoSplashscreen: true と @capacitor/splash-screen を使用して launchAutoHide: false.
Android、iOS、Electron で利用可能です。
デフォルト: "atBackground" (true は引き続き受け付けられます)
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "onlyDownload" } }}channelUrl
「channelUrl」セクションチャネル操作の URL/エンドポイントを設定します。
Android、iOS、Electron で利用可能です。
デフォルト: https://plugin.capgo.app/channel_self
{ "plugins": { "CapacitorUpdater": { "channelUrl": "https://example.com/api/channel" } }}defaultChannel
「defaultChannel」セクション設定ファイルでアプリのデフォルトチャネルを指定します。大文字と小文字を区別します。 この設定はクラウドで設定されたデフォルトチャネルを上書きしますが、クラウドで設定された上書き設定は引き続き優先されます。
Android、iOS、Electron で利用可能です。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "defaultChannel": "production" } }}directUpdate
「directUpdate」セクション非推奨。代わりに
autoUpdate文字列モードを使用してください:"atInstall","onLaunch"、または"always"。 このオプションは既存のアプリのために引き続きサポートされます。 即時適用は、以下とアップロードする必要があります:--delta更新がユーザー体験を遅らせないようにします。これらのモードにはautoSplashscreen: trueと@capacitor/splash-screenを使用してlaunchAutoHide: false.
オプション:
false: 直接アップデートは行わないでください'atInstall': 同上autoUpdate: "atInstall"'onLaunch': 同上autoUpdate: "onLaunch"'always': 同上autoUpdate: "always"true: (非推奨) 同上"always"後方互換性のため
Android、iOS、Electron で利用可能です。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "autoUpdate": "atInstall" } }}disableJSLogging
「disableJSLogging」セクションプラグインの JavaScript ログ出力を無効にします。true を設定すると、プラグインは JavaScript コンソールにログを出力しなくなります。ネイティブログのみが出力されます。
Android、iOS、Electron で利用可能です。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "disableJSLogging": true } }}keepUrlPathAfterReload
「keepUrlPathAfterReload」セクションリロード後も URL パスを保持するようにプラグインを設定します。
Android、iOS、Electron で利用可能です。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "keepUrlPathAfterReload": true } }}periodCheckDelay
「periodCheckDelay」セクション定期更新チェックの遅延期間を設定します。単位は秒です。 600秒(10分)未満にはできません。
Android、iOS、Electron で利用可能です。
デフォルト: 600 (10分)
{ "plugins": { "CapacitorUpdater": { "periodCheckDelay": 600 // (10 minutes) } }}publicKey
「publicKey」セクションエンドツーエンドのlive update暗号化バージョン2用の公開鍵を設定します。
Android、iOS、Electron で利用可能です。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "publicKey": "YOUR_PUBLIC_KEY" } }}resetWhenUpdate
「resetWhenUpdate」セクションデバイスに新しいネイティブアプリのbundleがインストールされた場合、以前にダウンロードしたbundleを自動的に削除します。
Android、iOS、Electron で利用可能です。
デフォルト: true
{ "plugins": { "CapacitorUpdater": { "resetWhenUpdate": false } }}responseTimeout
「responseTimeout」セクションネイティブプラグインが API をタイムアウトとみなすまでに待機するミリ秒数を設定します。
Android、iOS、Electron で利用可能です。
デフォルト: 20 (20秒)
{ "plugins": { "CapacitorUpdater": { "responseTimeout": 10 // (10 seconds) } }}shakeMenu
「shakeMenu」セクションデバッグ/テスト用に、シェイクジェスチャーで更新メニューを表示できるようにします。
Android、iOS、Electron で利用可能です。
デフォルト: false
{ "plugins": { "CapacitorUpdater": { "shakeMenu": true } }}statsUrl
「statsUrl」セクションアップデート統計の送信先 URL / エンドポイントを設定します。
Android、iOS、Electronで利用可能です。明示的な統計レポートを無効にするには "" を設定してください。 /stats.
無効化 statsUrl しても、Capgo のすべてのデバイスストレージが無効になるわけではありません。もし updateUrl が有効なままの場合、 /updates アップデートの配信やMAUのカウントに必要な、課金用MAU行、デバイスインベントリ、およびアップデート判定イベントのデータは引き続き保存されます。詳細は コンプライアンス のフィールドごとの内訳を参照してください。
デフォルト: https://plugin.capgo.app/stats
{ "plugins": { "CapacitorUpdater": { "statsUrl": "https://example.com/api/stats" } }}updateUrl
「updateUrl」セクションアップデートの確認先となるURLまたはエンドポイントを設定します。
Android、iOS、Electron で利用可能です。
デフォルト: https://plugin.capgo.app/updates
{ "plugins": { "CapacitorUpdater": { "updateUrl": "https://example.com/api/auto_update" } }}version
「version」セクションアプリの現在のバージョンを設定します。これは初回アップデートのリクエストに使用されます。 設定されていない場合、プラグインはネイティブの code からバージョンを取得します。
Android、iOS、Electron で利用可能です。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "version": "1.0.0" } }}localApi
「localApi」セクションテスト用にローカルの api を使うように CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localApi": "http://localhost:54321/functions/v1" } }}localApiFiles
「localApiFiles」セクションテスト用にローカルファイル api を使うように CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localApiFiles": "http://localhost:54321/functions/v1/files" } }}localHost
「localHost」セクションテスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localHost": "http://localhost:5173" } }}localSupa
「localSupa」セクションテスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localSupa": "http://localhost:54321" } }}localSupaAnon
「localSupaAnon」セクションテスト用のローカルサーバーを使うよう CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localSupaAnon": "YOUR_LOCAL_ANON_KEY" } }}localWebHost
「localWebHost」セクションテスト用のローカルサーバー、またはセルフホストのアップデートサーバーを使うよう CLI を設定します。
デフォルト: undefined
{ "plugins": { "CapacitorUpdater": { "localWebHost": "http://localhost:5173" } }}設定から続ける
「Settingsから続ける」というセクション使用している場合 設定 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。