設定

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

ヒント

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

注意

CapgoのEUデータリザンスが必要ですか？Cloudflareの updateUrl を https://plugin.eu.capgo.app/updates, statsUrl を https://plugin.eu.capgo.app/statsを channelUrl . https://plugin.eu.capgo.app/channel_selfデータの場所 「allowModifyUrl」セクション.

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"、または "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"。 文字列値は、以前のAuto UpdateとDirect Updateの設定をマージします。

オプション:

• "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で設定してください。ケースシティです。 cloudで設定されたデフォルトチャンネルを上書きしますが、cloudで設定されたオーバーライドを尊重します。

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

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

現在のアプリのバージョンを設定します。これは、最初のアップデートリクエストに使用されます。 設定されていない場合、プラグインはネイティブの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の概要を参照してください。 導入 実装詳細については導入を参照してください。 APIのキー 実装詳細についてはAPIのキーを参照してください。 デバイス 実装詳細についてはデバイスを参照してください。