設定

更新システムをより細かな制御で設定するには、これらの設定を使用できます。

ヒント

これらの設定の変更は、capacitor.configファイルに保存されます。プラットフォームを同期し、ストアにリリースする必要があります。プロダクションアプリがこれらの設定を受信するには。

注意

CapgoのEUデータリザンスが必要ですか？Cloudflareの updateUrl to https://plugin.eu.capgo.app/updates, statsUrl to https://plugin.eu.capgo.app/stats, そして channelUrl to 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

インスタント適用モードの場合に必要です（「または」、「）」を含む、廃止された「値」も含みます。インストールして設定します。 有効にすると、更新が適用されたり、更新が必要ない場合に、プラグインはスプラッシュスクリーンを非表示にします。 これにより、手動でアプリが準備されたときにアプリを準備したイベントをリスンし、スプラッシュスクリーンを非表示にする必要がなくなります。"atInstall", "onLaunch"AndroidとiOSで利用可能 "always"標準値: directUpdate __CAPGO_KEEP_0__.config.json @capacitor/splash-screen Section titled “autoSplashscreen” launchAutoHide: falseRequired when using instant apply modes (

, or

), including the deprecated false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall",
      "autoSplashscreen": true
    },
    "SplashScreen": {
      "launchAutoHide": false
    }
  }
}

autoUpdate

プラグインの更新を設定します。プラグインはアプリが前面に表示されるときに、そしてアプリが開いている間の繰り返しタイマーで更新を確認します。 periodCheckDelay タイマー間隔を制御します。 真値は、バックグラウンド互換性のためにまだサポートされています: true は同じです "atBackground" そして false は同じです "off"String値は、以前のAuto UpdateとDirect Updateの設定をマージします。

オプション:

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

Instant apply modes ("atInstall", "onLaunch", "always") は、ユーザーが待っている間にも適用される。アップロードは npx @capgo/cli@latest bundle upload --delta so ただ変更されたファイルのみダウンロードする。フルZIPアップロードはユーザー体験を遅くする。AndroidおよびiOSでは、これらのモードには autoSplashscreen: true と、必要です。 @capacitor/splash-screen with launchAutoHide: false.

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

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

デフォルト: undefined

capacitor.config.json

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

directUpdate

廃止。代わりに autoUpdate 文字モードを使用してください: "atInstall", "onLaunch", または このオプションは既存のアプリ向けにサポートされます。 ユーザー体験が遅くなることを防ぐために、インスタントアップデートをアップロードする必要があります。これらのモードは "always"要件があります。 --delta string modes autoSplashscreen: true かつ @capacitor/splash-screen と launchAutoHide: false.

オプション:

• false: 直接更新しない
• 'atInstall': 同じ autoUpdate: "atInstall"
• 'onLaunch': 同じ autoUpdate: "onLaunch"
• 'always': 同じ autoUpdate: "always"
• true: (廃止) 同じ "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

エンドツーヘンド ライブアップデート暗号化のための公開鍵を設定 Version 2.

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

デフォルト: undefined

capacitor.config.json

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

注意

publicKey 暗号化 V2 を構成し、アップロード時に使用したプライベート キーと一致する必要があります。デルタ更新の場合、V2 暗号化を使用し、部分暗号化を有効にして、組織がアップロードされるすべてのアップデートを暗号化することを要求する場合、暗号化されたバンドル強制を有効にします。ただし、 publicKey 単独では、サーバー側のポリシーとして非暗号化されたデルタが公開されることを防ぐものではありません。

resetWhenUpdate

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

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

デフォルト: true

capacitor.config.json

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

responseTimeout

APIのnativeプラグインがタイムアウトと考えるまでのミリ秒数を設定します。

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

デフォルト: 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 有効の場合でも、請求MAU行、デバイスインベントリ、更新決定イベントデータが必要なアップデートを提供し、MAUをカウントするために使用されます。 /updates 「Compliance」参照 「Compliance」 フィールドごとの詳細について。

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

CapgoをCLIに設定して、テスト用のローカルファイルapiを使用してください。

デフォルト: undefined

capacitor.config.json

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

localHost

CapgoをCLIに設定して、ローカルサーバーまたは自主的なアップデートサーバーをテストまたは使用してください。

デフォルト: undefined

capacitor.config.json

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

localSupa

CapgoをCLIに設定して、ローカルサーバーまたは自主的なアップデートサーバーをテストまたは使用してください。

デフォルト: 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 設定から続けて

セクション名 “設定から続けて”

設定 __CAPGO_KEEP_0__ と連携してダッシュボードと __CAPGO_KEEP_0__ の運用を計画する場合 API/__CAPGO_KEEP_1__-updater @API/__CAPGO_KEEP_1__-updater を使用します capgo/capacitor-updater for the native capability in Using @capgo/capacitor-updater, API オーバービュー API オーバービューの実装詳細について 導入 導入の実装詳細について API キー API キーの実装詳細について、 デバイス デバイスの実装詳細について。