設定

更新システムをより細かい制御が可能になります。以下の設定で構成できます。

ヒント

capacitor.configファイルの設定変更は、capacitor.configファイルの変更に伴うすべての設定変更を含みます。

注記

CloudフリーワールドにEUデータ居住地が必要ですか？ Capgo Cloudを設定してください。 updateUrl に設定します。 https://plugin.eu.capgo.app/updates, statsUrl に設定します。 https://plugin.eu.capgo.app/stats、 channelUrl に設定します。 https://plugin.eu.capgo.app/channel_selfを参照してください。 データの保存場所.

独自のホスト名を使用するには updateUrl, statsUrl, そして channelUrl, ご覧ください カスタム ドメイン設定.

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"、または "always"), 依存関係の廃止された directUpdate 値をインストールして設定します。 有効にすると、更新が適用された後または更新が必要ない場合に、スプラッシュスクリーンを非表示にします。 これにより、appReadyイベントを手動でリスンし、SplashScreen.hide()を呼び出す必要がなくなります。 @capacitor/splash-screen セットする launchAutoHide: falseデフォルト:

__CAPGO_KEEP_0__.config.json

クリップボードにコピー false

capacitor.config.json

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

autoUpdate

Copy to clipboard periodCheckDelay Section titled “autoUpdate” true 同様のもの "atBackground" かつ false 同様のもの "off"オプション:

または

• "off" オプション: false自動更新の確認を無効にする
• "atBackground" オプション: trueアプリが前景に表示されるたびに自動で確認し、ダウンロードし、次にアプリがバックグラウンドに移動するときに更新を適用する
• "atInstall"アプリが最初にインストールされたときまたはネイティブアプリストアの更新が行われたときにのみ即時適用する。そうでない場合は "atBackground" 動作
• "onLaunch"アプリがキルされた状態から前景に表示されるたびに即時適用する。最初の確認後は "atBackground" 振る舞い
• "always": フォアグラウンドのトランジションごとにチェックし、更新が利用可能な場合に即時適用
• "onlyDownload": チェックし、自動ダウンロードし、 updateAvailable: ダウンロードし、

: その後、次のバンドルや自動適用は行わない"atInstall", "onLaunch", "always"即時適用モード ( npx @capgo/cli@latest bundle upload --delta ) は、ユーザーが待っている間も適用される。ファイルの変更のみをアップロードすることで、 autoSplashscreen: true and @capacitor/splash-screen : launchAutoHide: false.

:

: "atBackground" (true and

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". 既存のアプリケーション向けにサポートが継続されるため、このオプションは残っています。 インスタント アプリケーションは、更新がユーザー エクスペリエンスに影響を与えないようにアップロードする必要があります。これらのモードには --delta と autoSplashscreen: true と @capacitor/splash-screen オプション: launchAutoHide: false.

: 直接アップデートを実行しない

• falsewith
• 'atInstall': 同じ autoUpdate: "atInstall"
• 'onLaunch': 同じ autoUpdate: "onLaunch"
• 'always': 同じ autoUpdate: "always"
• true: (deprecated) 同じ "always" バックワード互換性のために

Android、iOS、Electronで利用可能

Default: 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

period update のチェック間隔を設定します。単位は秒です。600秒以上 (10分) になります。

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

Default: 600 10分

capacitor.config.json

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

publicKey

エンドツーエンド live update 暗号化 Version 2 のための公開鍵を設定します。

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

Default: undefined

capacitor.config.json

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

注意

publicKey __CAPGO_KEEP_0__.config.jsonはV2の暗号化とアップロード時に使用した秘密鍵を一致させる必要があります。デルタアップデートの場合、V2暗号化を使用し、部分暗号化を有効にして、組織がアップロードを暗号化することを必須としている場合、暗号化されたバンドル強制を有効にしてください。 publicKey __CAPGO_KEEP_0__.config.jsonはV2暗号化を使用し、部分暗号化を有効にしてください。ただし、

resetWhenUpdate

「resetWhenUpdate」セクション

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

Default: 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をカウントするために必要なデータを保存します。 詳細は「 Compliance

」を参照してください。 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で利用可能です。

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

Default: 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をローカルサーバーでテストするように設定します。

デフォルト: 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 ウェブアプリ チャンネルごとに設定できる機能です。ネイティブアプリのリリースが必要なくても。

設定から続けてください。

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