設定

__CAPGO_KEEP_0__のセットアップコマンドをコピーし、インストールステップとこのプラグインのフルマークダウンガイドまでの全てのステップを含む。

更新システムの詳細な制御を得るには、これらの設定を使用して構成できます。

`allowModifyUrl`

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

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

標準値: false

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

`appId`

アプリのIDを設定します。

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

デフォルト: undefined

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

`appReadyTimeout`

ネイティブプラグインがアップデートを失敗と見なすまで待つ時間数をミリ秒単位で指定します。

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

デフォルト: 10000 (10秒)

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

`autoDeleteFailed`

失敗したバンドルを自動的に削除するかどうかを設定します。

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

デフォルト: true

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

`autoDeletePrevious`

更新が成功した後、自動的に前のバンドルを削除するかどうかを設定します。

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

デフォルト: true

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

`autoSplashscreen`

インスタント適用モードを使用する際に自動的にスプラッシュスクリーンを非表示にすることができます。有効にすると、更新が適用された後もしくは更新が必要ない場合に、プラグインは自動的にスプラッシュスクリーンを非表示にします。この機能により、手動でアプリが準備されたイベントをリスンし、スプラッシュスクリーンを非表示にする必要がなくなります。ただし、以下の条件を満たす必要があります。 autoUpdate は "atInstall", "onLaunch"、または "always"。 directUpdate バックグラウンド互換性のために、古い値もサポートされています。 @capacitor/splash-screen プラグインがインストールされ、launchAutoHide: false で構成されている必要があります。 Auto Update が有効になっている必要があります。

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

標準値: false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    }
  }
}

`autoUpdate`

ライブアップデートの設定 periodCheckDelay タイマー間隔を制御します。 Boolean値は、バックグラウンド互換性のためにまだサポートされています: true は同じです "atBackground" または false は同じです "off"と

オプション:

"off" または false自動アップデートの確認を無効にします
"atBackground" または trueフォアグラウンドの確認ごとに自動で確認してダウンロードし、次にアプリがバックグラウンドに移動したときにアップデートを適用します
"atInstall"は即時適用しますが、最初のインストールまたはネイティブアプリストアのアップデートの後のみ; それ以外の場合は "atBackground" 動作
"onLaunch": アプリがキルされた状態からフォアグラウンドに戻されたときにのみ、即座に適用します (冷たいスタート)。その最初のチェック後、最初のチェック以降は "atBackground" 動作
"always": フォアグラウンドのトランジションごとにチェックし、更新が利用可能な場合に即座に適用します
"onlyDownload": チェックし、自動でダウンロードし、 updateAvailable, そして、次のバンドルを設定したり、更新を自動で適用したりしない

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

デフォルト: "atBackground" (true まだ受け入れられている)

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

`channelUrl`

__CAPGO_KEEP_0__.config.json

Android、iOS、Electronで利用可能

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

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

`defaultChannel`

アプリのデフォルトチャンネルを設定します。ケース感受性あり。クラウドで設定されたデフォルトチャンネルを上書きしますが、クラウドで設定されたオーバーライドを尊重します。

Android、iOS、Electronで利用可能

デフォルト: undefined

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

`directUpdate`

廃止。使用 autoUpdate 文字モードの代わりに: "atInstall", "onLaunch"、または "always" このオプションは既存のアプリケーション向けにサポートが継続されるため、廃止されません。

オプション:

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`

エンドツーエンドライブアップデート暗号化のバージョン2のためのパブリックキーを設定

Android、iOS、Electronで利用可能

デフォルト: undefined

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

`resetWhenUpdate`

自動的に、デバイスに新しいネイティブアプリケーションバンドルがインストールされたときに、以前ダウンロードしたバンドルを削除します。

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/エンドポイントを構成します。

Android、iOS、およびElectronで利用可能です。""に設定すると、明示的な統計レポートを通じて /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`

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

デフォルト: 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`

Configure the CLI to use a local server for testing or self-hosted update server.

標準: undefined

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

`localSupaAnon`

Configure the CLI to use a local server for testing.

標準: undefined

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

`localWebHost`

Configure the CLI to use a local server for testing or self-hosted update server.

標準: undefined

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

Capgoを使用している場合

Capgoのダッシュボードと__CAPGO_KEEP_0__のオペレーションを計画する場合、Capgoを接続してください。設定 to plan dashboard and API operations, connect it with Capgoの@capgo/capacitor-updater Capgoの@capgo/capacitor-updaterの使用 APIの概要 APIの実装詳細 Capgoの概要 __CAPGO_KEEP_0__のキーの実装詳細 API Keys for the implementation detail in API Keys, and 前のページ Capgoの@__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updaterの使用