設定

インストール手順と、このプラグインの完全なMarkdownガイドを含むセットアッププロンプトをコピーします。

アップデートシステムをより詳細に制御するには、以下の設定を使用できます：

独自のホスト名を使用するには、 updateUrl, statsUrlや channelUrl を参照してください。カスタムドメインの設定.

`allowModifyUrl`

JavaScript側から updateUrl、statsUrl、channelUrl を動的に変更できるようにします。

Android、iOS、Electron で利用可能です。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

`appId`

config でアプリの app id を設定します。

Android、iOS、Electron で利用可能です。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

`appReadyTimeout`

アップデートを「失敗」と判定するまでに、ネイティブプラグインが待機するミリ秒数を設定します。

Android、iOS、Electron で利用可能です。

デフォルト: 10000 (10秒)

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

`autoDeleteFailed`

アップデートに失敗したbundleを自動的に削除するかどうかを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

`autoDeletePrevious`

アップデート成功後に、古いbundleを自動的に削除するかどうかを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

`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`

プラグインによる Live Update の確認、ダウンロード、適用方法を設定します。アプリがフォアグラウンドに移行した際、およびアプリ起動中に一定の間隔で更新を確認します。 periodCheckDelay タイマーの間隔を制御します。後方互換性のために、引き続き Boolean 値も使用可能です： true と同じです "atBackground" と false と同じです "off"。 String 値を使用する場合、従来の Auto Update と Direct Update の設定がマージされます。

オプション:

"off" または false: 自動更新の確認を無効にする
"atBackground" または true: フォアグラウンド移行時の確認ごとに自動でチェックとダウンロードを行い、次にアプリがバックグラウンドに移行したタイミングで更新を適用する
"atInstall": 新規インストールまたはApp StoreでのNative Build更新直後にのみ即時適用し、それ以外は "atBackground" の挙動を使用します
"onLaunch": アプリが終了状態からフォアグラウンドに移行した時（コールドスタート）にのみ即時適用します。その後のチェックは "atBackground" の挙動を使用します
"always": フォアグラウンドへの移行時に毎回チェックを行い、アップデートがあれば即時適用します
"onlyDownload": 自動的にチェックとダウンロードを行い、 updateAvailableをエミットします。次のbundleの設定やアップデートの適用は自動では行いません

即時適用モード ("atInstall", "onLaunch", "always") apply while the user is waiting. Upload with npx @capgo/cli@latest bundle upload --delta 変更されたファイルのみがダウンロードされます。フルzipのuploadはユーザー体験を損なうためです。AndroidおよびiOSでは、これらのモードには autoSplashscreen: true と @capacitor/splash-screen を使用して launchAutoHide: false.

Android、iOS、および Electron で利用可能です。

デフォルト: "atBackground" (true （まだ受け付けられます）

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "onlyDownload"
    }
  }
}

`channelUrl`

チャンネル操作用の URL / エンドポイントを設定します。

Android、iOS、および Electron で利用可能です。

デフォルト: https://plugin.capgo.app/channel_self

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

`defaultChannel`

configでアプリのデフォルトチャネルを設定します（大文字・小文字を区別）。この設定はクラウド上のデフォルトチャネルを上書きしますが、クラウド側で行われた個別のオーバーライドは優先されます。

Android、iOS、およびElectronで利用可能です。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "defaultChannel": "production"
    }
  }
}

`directUpdate`

非推奨。代わりに autoUpdate stringモードを使用してください： "atInstall", "onLaunch"、または "always".\nこのオプションは既存のアプリでも引き続きサポートされます。\nInstant apply を使用する場合は、以下をアップロードしてください --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`

プラグインのJavaScriptログ出力を無効にします。trueに設定すると、JavaScriptコンソールへのログ出力は行われず、ネイティブログのみが記録されます。

Android、iOS、Electronで利用可能です。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

`keepUrlPathAfterReload`

リロード後もURLパスを保持するようにプラグインを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

`periodCheckDelay`

定期的なアップデート確認の間隔を設定します。単位は秒です。 600秒（10分）未満に設定することはできません。

Android、iOS、Electronで利用可能です。

デフォルト: 600 (10分)

{
  "plugins": {
    "CapacitorUpdater": {
      "periodCheckDelay": 600 // (10 minutes)
    }
  }
}

`publicKey`

Version 2のlive updateエンドツーエンド暗号化用の公開鍵を設定します。

Android、iOS、および Electron で利用可能です。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "publicKey": "YOUR_PUBLIC_KEY"
    }
  }
}

`resetWhenUpdate`

新しい Native Build のアプリバンドルがデバイスにインストールされた際、以前にダウンロードしたバンドルを自動的に削除します。

Android、iOS、および Electron で利用可能です。

デフォルト: true

{
  "plugins": {
    "CapacitorUpdater": {
      "resetWhenUpdate": false
    }
  }
}

`responseTimeout`

API のタイムアウトと判定するまでに、ネイティブプラグインが待機するミリ秒数を設定します。

Android、iOS、Electron で利用可能です。

デフォルト: 20 (20秒)

{
  "plugins": {
    "CapacitorUpdater": {
      "responseTimeout": 10 // (10 seconds)
    }
  }
}

`shakeMenu`

デバッグやテスト用に、シェイクジェスチャーでアップデートメニューを表示する機能を有効にします。

Android、iOS、Electron で利用可能です。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "shakeMenu": true
    }
  }
}

`statsUrl`

アップデートの統計情報を送信するURLまたはエンドポイントを設定します。

Available on Android, iOS, and Electron. Set to "" to disable explicit stats reporting through /stats.

無効化 statsUrl しても、Capgo のすべてのデバイスストレージが無効になるわけではありません。もし updateUrl が有効なままの場合、 /updates アップデートの配信やMAUのカウントに必要な、課金用MAU行、デバイスインベントリ、アップデート決定イベントのデータは引き続き保存されます。詳細はコンプライアンスのフィールドごとの内訳を参照してください。

デフォルト: https://plugin.capgo.app/stats

{
  "plugins": {
    "CapacitorUpdater": {
      "statsUrl": "https://example.com/api/stats"
    }
  }
}

`updateUrl`

アップデートの確認リクエストを送信するURLまたはエンドポイントを設定します。

Android、iOS、Electronで利用可能です。

デフォルト: https://plugin.capgo.app/updates

{
  "plugins": {
    "CapacitorUpdater": {
      "updateUrl": "https://example.com/api/auto_update"
    }
  }
}

`version`

アプリの現在のバージョンを設定します。これは初回アップデートのリクエストに使用されます。設定されていない場合、プラグインはネイティブの code からバージョンを取得します。

Android、iOS、Electronで利用可能です。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "version": "1.0.0"
    }
  }
}

開発設定

`localApi`

テスト用に CLI でローカルの api を使用するように設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localApi": "http://localhost:54321/functions/v1"
    }
  }
}

`localApiFiles`

テスト用に CLI でローカルファイル api を使用するように設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localApiFiles": "http://localhost:54321/functions/v1/files"
    }
  }
}

`localHost`

テスト用のローカルサーバーや、自前でホストするアップデートサーバーを使用するように CLI を設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localHost": "http://localhost:5173"
    }
  }
}

`localSupa`

テスト用のローカルサーバーや、自前でホストするアップデートサーバーを使用するように CLI を設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupa": "http://localhost:54321"
    }
  }
}

`localSupaAnon`

テスト用にローカルサーバーを使用するよう CLI を設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

`localWebHost`

テスト用ローカルサーバー、またはセルフホストのアップデートサーバーを使用するよう CLI を設定します。

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localWebHost": "http://localhost:5173"
    }
  }
}

Settingsから続行

使用している場合設定ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-updater を使用する「@capgo/capacitor-updater を使用する」のネイティブ機能については、 API の概要「API の概要」の実装の詳細については、はじめに「はじめに」における実装の詳細については、 API キーおよび「API Keys」の実装の詳細については、デバイス実装の詳細については Devices を参照してください。