設定

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

ヒント

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

Native プラグインがアップデートを失敗と見なすまで待機するミリ秒数を設定します。

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"または "always"。 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__/splash-screen プラグインがインストールされ、launchAutoHide: false で構成されている場合にのみ機能します。 Auto Update が有効になっている場合にのみ機能します。

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

capacitor.config.json

{
  "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 はまだ受け入れられます)

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 __CAPGO_KEEP_0__

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で利用可能です。""に設定すると、明示的な統計レポートを無効にしますが、__CAPGO_KEEP_0__デバイスのすべてのストレージを無効にしないことに注意してください。 /stats.

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

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

capacitor.config.json

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

updateUrl

__CAPGO_KEEP_0__.config.json

コピー

「updateUrl」のセクション 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

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

デフォルト: 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をローカルサーバーでテストまたは自主的な更新サーバーを使用するように設定します。

デフォルト: 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__ Web アプリには、チャンネルごとに設定できる追加の設定が用意されています。 Capgo Web アプリ 設定から続ける

「設定から続ける」のセクション

設定 設定 計画ダッシュボードとAPIのオペレーションを計画し、APIに接続する Using @capgo/capacitor-updater Using @capgo/capacitor-updaterのネイティブ機能 APIの概要 APIの概要の実装詳細 導入 導入の実装詳細 APIのキー APIのキーと実装詳細 デバイス デバイスの実装詳細