設定

このプラグインのインストール手順と全体のマークダウンガイドを含むセットアップコマンドをコピーできます。

更新システムの制御をより細かく行うには、これらの設定を使用して構成できます。

`allowModifyUrl`

プラグインがURLを変更できるようにします。

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`

スプラッシュスクリーンの自動非表示をインスタント適用モードで使用する場合に自動的に処理します。有効にすると、更新が適用されたり、更新が必要ない場合にスプラッシュスクリーンを自動的に非表示にします。この機能により、appReadyイベントを手動でリスンし、SplashScreen.hide()を呼び出す必要がなくなります。ただし、 autoUpdate に設定されている場合にのみ機能します。 "atInstall", "onLaunch"バージョン "always"はまだサポートされていますが、後方互換性のために使用することをお勧めします。 @__CAPGO_KEEP_0__/splash-screen プラグインがインストールされ、launchAutoHide: falseで構成されている必要があります。 Auto Updateが有効になっている必要があります。 directUpdate values are still supported for backward compatibility. Requires the @capacitor/splash-screen plugin to be installed and configured with launchAutoHide: false. Requires Auto Update to be enabled.

__CAPGO_KEEP_0__

デフォルト: false

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

`autoUpdate`

プラグインがライブアップデートをチェックする、ダウンロードする、適用する方法を設定します。アプリが前面に表示されるときと、アプリが開いている間、定期的にタイマーを使用してアップデートをチェックします。 periodCheckDelay タイマー間隔を制御します。バックグラウンド互換性のために、真偽値はまだサポートされています: true と同じです "atBackground" または false と同じです "off". 文字列値は、以前のAuto UpdateとDirect Updateの設定をマージします。

オプション:

"off" または false: 自動更新の確認を無効にする
"atBackground" : フォアグラウンドの確認ごとに自動で確認し、ダウンロードし、バックグラウンドに移動したときに更新を適用する true: フレッシュインストールまたはネイティブアプリストアの更新時のみ即時適用する。そうでない場合は
"atInstall": アプリがキルド状態からフォアグラウンドに戻されたときにのみ即時適用する。最初の確認後は "atBackground" : フォアグラウンドのトランジションごとに確認し、更新が利用可能な場合に即時適用する
"onLaunch": 即時適用せず、 "atBackground" : を発行し、次のバンドルを設定せずに自動で更新を適用しない
"always": Android、iOS、Electronで利用可能。
"onlyDownload": Default: updateAvailable: __CAPGO_KEEP_0__

: __CAPGO_KEEP_1__

: __CAPGO_KEEP_2__ "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で利用可能です。

Default: undefined

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

`directUpdate`

廃止。代わりに autoUpdate 文字列モードを使用してください： "atInstall", "onLaunch"、または。このオプションは既存のアプリケーション向けにサポートを維持しています。 "always"オプション：

：直接更新を実行しない

false：
'atInstall'：同等の設定を使用する autoUpdate: "atInstall"
'onLaunch'：同等の設定を使用する autoUpdate: "onLaunch"
'always': 同じ autoUpdate: "always"
true: (非推奨) 同じ "always" for backward compatibility

Android、iOS、Electronで利用可能。

Default: false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

`disableJSLogging`

プラグインのJavaScriptログを無効にします。trueの場合、プラグインはJavaScriptコンソールにログを出さず、ネイティブログのみ行われます。

Android、iOS、Electronで利用可能。

Default: false

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

`keepUrlPathAfterReload`

URLパスを再読み込み後に保持する設定をプラグインで設定します。

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

デフォルト値 false

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

`periodCheckDelay`

URLパスを再読み込み後に保持する設定をプラグインで設定します。

Android、iOS、Electronで利用可能。

デフォルト: 600 (10分)

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

`publicKey`

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

Android、iOS、Electronで利用可能。

デフォルト: undefined

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

`resetWhenUpdate`

__CAPGO_KEEP_0__.config.json

Android、iOS、Electronで利用可能

Default: true

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

`responseTimeout`

APIのnativeプラグインがタイムアウトを考慮する前に、ms単位で何秒待つかを設定します。

Android、iOS、Electronで利用可能

Default: 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 __CAPGO_KEEP_0__.config.json Compliance still stores the billing MAU row, device inventory, and update-decision event data needed to serve updates and count MAU. See

Compliance https://plugin.capgo.app/stats

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

`updateUrl`

Configure the URL / endpoint to which update checks are sent.

updateUrl

Capgoの更新チェックを送信するURL/エンドポイントを設定します。 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`

Configure the CLI to use a local api for testing.

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

設定から続ける

__CAPGO_KEEP_0__を使用している場合、設定ダッシュボードとAPIのオペレーションを計画するには、 Using @capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater API Overview for the implementation detail in API Overview Introduction for the implementation detail in Introduction API Keys for the implementation detail in API Keys, and Devices for the implementation detail in Devices.