設定

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

ヒント

これらの設定の変更は、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

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

デフォルト:

__CAPGO_KEEP_0__.config.json 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

インスタント適用モードを使用する際にスプラッシュスクリーンを自動的に非表示にするようにします。有効にすると、更新が適用されたり、更新が必要ない場合に、プラグインは自動的にスプラッシュスクリーンを非表示にします。 この機能は、手動でアプリが準備されたときにアプリ準備イベントをリスンし、スプラッシュスクリーンを非表示にする必要がなくなります。 ただし、以下の条件を満たす場合にのみ機能します： autoUpdate に設定されている場合、または "atInstall", "onLaunch"に設定されている場合。LEGACY "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__.config.json false

capacitor.config.json

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

autoUpdate

プラグインの更新を設定します。アプリが前面に表示されるときや、再帰的にアプリが開いている間、プラグインは更新をチェックします。 periodCheckDelay タイマー間隔を制御します。 バックグラウンド互換性のために、真偽値はまだサポートされています: true は同じです "atBackground" と false は同じです "off"オプション:

または

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

Android、iOS、Electronで利用可能。

デフォルト: "atBackground" (true まだ有効です)

capacitor.config.json

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

channelUrl

チャンネルオペレーションのURL/エンドポイントを設定してください。

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

デフォルト: 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" このオプションは既存のアプリケーション向けにサポートされます。

オプション:

• 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

エンドツーエンドのライブアップデート暗号化用の公開鍵を設定するバージョン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タイムアウトと考えるまでのミリ秒数を設定します。

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

デフォルト: 20 (20秒)

capacitor.config.json

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

shakeMenu

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

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

デフォルト: false

capacitor.config.json

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

statsUrl

アップデート統計を送信するURL/エンドポイントを構成します。

Android、iOS、およびElectronで利用可能です。 "" に設定すると、明示的な統計レポートを通じて /stats.

無効にする statsUrl すべてのCapgoデバイスのストレージを無効にしないことに注意してください。 updateUrl 残っている /updates まだ請求のMAU行、デバイスのインベントリ、更新決定イベントデータを保存し続けます。これはアップデートを提供し、MAUをカウントするために必要です。詳しくは コンプライアンス を参照してください。

フィールドごとの詳細は https://plugin.capgo.app/stats

capacitor.config.json

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

updateUrl

セクション：「updateUrl」

アップデートのチェックが送信されるURL/エンドポイントを設定します。

Android、iOS、Electronで利用可能です。 https://plugin.capgo.app/updates

capacitor.config.json

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

version

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

Android、iOS、Electronで利用可能

デフォルト: undefined

capacitor.config.json

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

開発設定

localApi

Configure the CLI to use a local api for testing.

デフォルト: undefined

capacitor.config.json

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

localApiFiles

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

デフォルト: undefined

capacitor.config.json

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

localHost

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

デフォルト: undefined

capacitor.config.json

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

localSupa

CLIをローカルサーバーでテストするか、自主的な更新サーバーを使用するように設定します。

Default: undefined

capacitor.config.json

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

localSupaAnon

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

Default: 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__ Web アプリには、チャネルごとに設定できる追加の設定が用意されています。 Capgo web app 「設定から続ける」セクション

あなたは

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