設定

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

ヒント

capacitor.configファイルの設定変更は、capacitorプラットフォームの同期とアプリのストアへのリリースが必要です。生産用アプリはこれらの変更を受け取ることができます。

注

Capgo CloudのEUデータ居住地が必要ですか? Capgo updateUrl に https://plugin.eu.capgo.app/updates, statsUrl に https://plugin.eu.capgo.app/stats、と channelUrl に https://plugin.eu.capgo.app/channel_self。 ご参照ください データの保存場所.

allowModifyUrl

JavaScript側から、updateUrl、statsUrl、channelUrlを動的に変更できるようにするプラグインを許可します。

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

デフォルト: false

capacitor.config.json

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

appId

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

Android、iOS、Electronで利用可能。

デフォルト: undefined

capacitor.config.json

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

appReadyTimeout

ネイティブ プラグインがアップデートを ‘失敗’ と考えるまでのミリ秒数を設定します。

Android、iOS、Electronで利用可能。

デフォルト: 10000 (10秒)

capacitor.config.json

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

autoDeleteFailed

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

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

デフォルト: true

capacitor.config.json

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

autoDeletePrevious

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

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

デフォルト: true

capacitor.config.json

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

autoSplashscreen

自動的にスプラッシュスクリーンを非表示にするモードを使用する場合に、自動適用モードでスプラッシュスクリーンを非表示にすることができます。有効にすると、更新が適用された後または更新が必要ない場合に、プラグインは自動的にスプラッシュスクリーンを非表示にします。 この機能により、appReadyイベントを手動でリスンし、SplashScreen.hide()を呼び出す必要がなくなります。 ただし、 autoUpdate is set to "atInstall", "onLaunch"、または "always"のいずれかでしか機能しません。 directUpdate は、バックグラウンド互換性のためにまだサポートされています。 @capacitor/splash-screen プラグインがインストールされ、launchAutoHide: false で構成されている場合にのみ機能します。 Auto Update が有効になっている場合にのみ機能します。 Android、iOS、および Electron で利用可能です。 デフォルト:

__CAPGO_KEEP_0__.config.json

コピー false

capacitor.config.json

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

autoUpdate

Copy to clipboard periodCheckDelay Section titled “autoUpdate” true は同じです。 "atBackground" かつ false は同じです。 "off". 文字列値は、前のAuto UpdateとDirect Updateの設定をマージします。

オプション:

• "off" または false:自動更新のチェックを無効にする
• "atBackground" または true:各前景チェック後に自動的にダウンロードして、次にアプリがバックグラウンドに移動するときに更新を適用する
• "atInstall":新規インストールまたはネイティブアプリストアの更新後にのみ適用する; それ以外の場合は "atBackground" 動作
• "onLaunch":アプリがキルされた状態から前景に戻されたときにのみ即座に適用する。最初のチェック後は、 "atBackground" 行動
• "always": フォアグラウンドのトランジションごとにチェックし、更新が利用可能な場合に即時適用
• "onlyDownload". Check して自動ダウンロード、emit updateAvailable、次のバンドルを設定せずに自動的に更新を適用しない

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

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

capacitor.config.json

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

channelUrl

チャンネルオペレーションのURL/エンドポイントを設定します。

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

Default: https://plugin.capgo.app/channel_self

capacitor.config.json

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

defaultChannel

アプリのデフォルトチャンネルをconfigで設定します。ケースシティです。 クラウドで設定されているデフォルトチャンネルを上書きしますが、クラウドで設定されているオーバーライドを尊重します。

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

Default: undefined

capacitor.config.json

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

directUpdate

廃止。代わりに autoUpdate stringモードを使用してください: "atInstall", "onLaunch"、または "always"既存のアプリ用途のために、このオプションは引き続きサポートされます。

オプション:

• false: 直接更新を行わない
• 'atInstall': __CAPGO_KEEP_0__.config.jsonと同じ autoUpdate: "atInstall"
• 'onLaunch': __CAPGO_KEEP_0__.config.jsonと同じ autoUpdate: "onLaunch"
• 'always': __CAPGO_KEEP_0__.config.jsonと同じ autoUpdate: "always"
• true: __CAPGO_KEEP_0__.config.jsonと同じ (非推奨) "always" 既存のバージョンの互換性のために

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

デフォルト: false

capacitor.config.json

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

disableJSLogging

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

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

デフォルト: false

capacitor.config.json

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

keepUrlPathAfterReload

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

注意

リロードがトリガーされた場合、'window.history'がクリアされます。

Android、iOS、Electronで利用可能。

デフォルト: false

capacitor.config.json

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

periodCheckDelay

期間更新チェックの待ち時間を設定します。単位は秒です。 600秒以上 (10分) である必要があります。

Android、iOS、Electronで利用可能。

デフォルト: 600 10分

capacitor.config.json

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

publicKey

__CAPGO_KEEP_0__.config.jsonの公開鍵をエンドツーエンドのライブアップデート暗号化用に設定

Android、iOS、Electronで利用可能

デフォルト undefined

capacitor.config.json

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

注意

publicKey エンドツーエンドのライブアップデート暗号化V2を設定し、アップロード時に使用したプライベートキーと一致させる必要があります。デルタアップデートの場合、V2暗号化を有効にし、パートIAL暗号化を有効にし、組織がアップロードを暗号化することを必須としている場合、暗号化されたバンドル強制を有効にします。 publicKey サーバーサイドのポリシーとしてのみ頼ることはできません。

resetWhenUpdate

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

Android、iOS、Electronで利用可能

Default: true

capacitor.config.json

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

responseTimeout

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

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

Default: 20 (20秒)

capacitor.config.json

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

shakeMenu

shakeジェスチャーを有効にして、デバッグ/テスト用の更新メニューを表示します。

Android、iOS、Electronで利用可能。

デフォルト: false

capacitor.config.json

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

statsUrl

__CAPGO_KEEP_0__の更新統計を送信するURL/エンドポイントを設定します。

Android、iOS、Electronで利用可能。""に設定すると、明示的な統計レポートを無効にします。 /stats.

無効にする statsUrl 無効にすることは、すべてのCapgoデバイスストレージを無効にしないことに注意してください。 updateUrl 有効のままにすると、 /updates 依然として、請求MAU行、デバイスインベントリ、および更新決定イベントデータを含む、更新を提供し、MAUをカウントするために必要なデータを保存します。 Compliance fieldレベルでの詳細を表示します。

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

capacitor.config.json

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

updateUrl

更新チェックが送信されるURL/エンドポイントを設定します。

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

Default: https://plugin.capgo.app/updates

capacitor.config.json

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

version

アプリの現在のバージョンを設定します。このバージョンは、最初の更新要求で使用されます。 バージョンが設定されていない場合、プラグインはネイティブcodeからバージョンを取得します。

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

デフォルト値： undefined

capacitor.config.json

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

開発設定

localApi

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

デフォルト値： undefined

capacitor.config.json

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

localApiFiles

Configure the CLI to use a local file api for testing.

デフォルト: undefined

capacitor.config.json

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

localHost

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

デフォルト: undefined

capacitor.config.json

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

localSupa

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

デフォルト: undefined

capacitor.config.json

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

localSupaAnon

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

デフォルト: undefined

capacitor.config.json

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

localWebHost

CLIをローカルサーバーまたは自主更新サーバーでテストするように設定します。

デフォルト: undefined

capacitor.config.json

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

ヒント

__CAPGO_KEEP_0__ ウェブ アプリには、チャンネルごとにネイティブ アプリのリリースが必要なく設定できる追加の設定が用意されています。 Capgo ネイティブ アプリのリリースが必要なく、チャンネルごとに設定できる追加の設定が用意されています。

設定から続けて

あなたが「 設定 」を使用してダッシュボードとAPIのオペレーションを計画している場合、APIと接続してください。 「@capgo/capacitor-updater」 を使用してネイティブ機能を実装する場合、capgo/capacitor-updaterと接続してください。 API まとめ API まとめの実装詳細について 導入 導入の実装詳細について API キー API キーの実装詳細について、 デバイス デバイスの実装詳細について。