設定

インストールのステップとこのプラグインのフルマークダウンガイドまで含むセットアッププロンプトをコピーしてください。

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

自分のホスト名を使用するには updateUrl, statsUrl, そして channelUrl, 以下を参照カスタムドメインの設定.

`allowModifyUrl`

JavaScript側からupdateUrl、statsUrl、channelUrlを動的に変更できるようにプラグインを許可する。

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

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "allowModifyUrl": true
    }
  }
}

`appId`

アプリのIDを設定します。

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

デフォルト: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "appId": "com.example.app"
    }
  }
}

`appReadyTimeout`

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

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

デフォルト: 10000 (10秒)

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000
    }
  }
}

`autoDeleteFailed`

失敗したバンドルを自動で削除するかどうかを設定します。

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

デフォルト: true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeleteFailed": false
    }
  }
}

`autoDeletePrevious`

自動更新後、前のバンドルを自動的に削除するかどうかを設定します。

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

標準値: true

{
  "plugins": {
    "CapacitorUpdater": {
      "autoDeletePrevious": false
    }
  }
}

`autoSplashscreen`

必要な場合、即時適用モードを使用するときに。"atInstall", "onLaunch", or "always"、 directUpdate 値を設定します。インストール @capacitor/splash-screen 設定します launchAutoHide: false. When enabled, the plugin hides the splashscreen after updates are applied or when no update is needed. This removes the need to manually listen for appReady events and call SplashScreen.hide().

AndroidおよびiOSで利用可能。

デフォルト: false

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

`autoUpdate`

プラグインのライブアップデートのチェック、ダウンロード、アプリケーションの適用方法を設定します。アプリが前面に表示されるときと、再帰的にタイマーが動作する間、プラグインはアップデートをチェックします。 periodCheckDelay タイマー間隔を制御します。バックグラウンド互換性のために、ブール値はまだサポートされています: true は同じです "atBackground" そして false は同じです "off". 文字列値は、以前のAuto UpdateとDirect Updateの設定をマージします。

オプション:

"off" または false: 自動更新チェックを無効にする
"atBackground" または true: フォアグラウンドのチェックごとに自動で更新をダウンロードし、次にアプリがバックグラウンドに移ると更新を適用する
"atInstall": フレッシュインストールまたはネイティブアプリストアの更新後のみ即時適用する。そうでない場合は "atBackground" behavior
"onLaunch": フォアグラウンドのトランジションごとにチェックし、更新が利用可能な場合に即時適用する "atBackground" behavior
"always": 自動でチェックし、ダウンロードし、更新を適用し、
"onlyDownload": そして、次のバンドルを設定したり、自動で更新を適用したりしない updateAvailable: 即時適用モード (

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

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

デフォルト: "atBackground" (true まだ受け入れられます

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

`channelUrl`

チャンネルオペレーションのURL/エンドポイントを設定します。

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

Default: https://plugin.capgo.app/channel_self

{
  "plugins": {
    "CapacitorUpdater": {
      "channelUrl": "https://example.com/api/channel"
    }
  }
}

`defaultChannel`

アプリのデフォルトチャンネルをconfigで設定します。ケース感受性あり。 cloudで設定したデフォルトチャンネルを上書きしますが、cloudでオーバーライドされた場合は尊重します。

Android、iOS、Electronで利用可能

Default: undefined

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

`directUpdate`

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

オプション:

false: 直接アップデートを行わない
'atInstall': 同じ autoUpdate: "atInstall"
'onLaunch': 同じ autoUpdate: "onLaunch"
'always': 同じ autoUpdate: "always"
true: (非推奨) 同じ "always" 既存の互換性のために

Android、iOS、Electronで利用可能。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": "atInstall"
    }
  }
}

`disableJSLogging`

プラグインのJavaScriptログを無効にします。trueの場合、プラグインはJavaScriptコンソールにログを出さなくなり、ネイティブログのみが行われます。

Android、iOS、Electronで利用可能。

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "disableJSLogging": true
    }
  }
}

`keepUrlPathAfterReload`

リロード後、URLパスを維持するプラグインの設定

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

デフォルト: false

{
  "plugins": {
    "CapacitorUpdater": {
      "keepUrlPathAfterReload": true
    }
  }
}

`periodCheckDelay`

期間更新チェックの待機時間を設定します。単位は秒です。600秒以上 (10分) になります。

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

デフォルト: 600 （10分）

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

`publicKey`

Configure the public key for end to end live update encryption Version 2.

Android、iOS、Electronで利用可能

デフォルト: undefined

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

`resetWhenUpdate`

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

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

Default: true

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

`responseTimeout`

ネイティブプラグインがAPIタイムアウトと考えるまで待つミリ秒数を設定します。

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

Default: 20 (20秒)

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

`shakeMenu`

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

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

デフォルト: false

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

`statsUrl`

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

Android、iOS、およびElectronで利用可能です。 "" に設定すると、明示的な統計レポートを無効にしますが、__CAPGO_KEEP_0__ デバイスストレージはすべて無効になりません。 /stats.

無効にする statsUrl Capgo device storageをすべて無効にすることはありません。もし updateUrl 残っている場合、 /updates まだ請求 MAU 行、デバイスインベントリ、更新決定イベントデータを保存し続けます。これらは、更新を提供し、MAU を数えるために必要です。詳しくは Compliance を参照してください。

詳細設定: https://plugin.capgo.app/stats

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

`updateUrl`

更新チェックの送信先の URL / エンドポイントを設定します。

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

詳細設定: https://plugin.capgo.app/updates

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

`version`

codeの現在のバージョンを設定します。このバージョンは、最初の更新要求に使用されます。設定されていない場合、プラグインはcodeからバージョンを取得します。

Android、iOS、Electronで利用可能

デフォルト: undefined

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

開発設定

`localApi`

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

デフォルト: undefined

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

`localApiFiles`

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

デフォルト: undefined

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

`localHost`

CLIをローカルサーバーでテストするか、自社のアップデートサーバーを使用するように設定します。

デフォルト: undefined

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

`localSupa`

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

Default: undefined

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

`localSupaAnon`

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

Default: undefined

{
  "plugins": {
    "CapacitorUpdater": {
      "localSupaAnon": "YOUR_LOCAL_ANON_KEY"
    }
  }
}

`localWebHost`

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

Default: undefined

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

セクション名：設定から続ける

設定 セクション名：設定から続ける 計画ダッシュボードとAPIの運用を、 Using @capgo/capacitor-updater native機能の使用にあたっては、Using @capgo/capacitor-updater APIの概要 APIの実装詳細概要 __CAPGO_KEEP_0__のキー APIの実装詳細、 for API の実装詳細についてデバイスの実装詳細 __CAPGO_KEEP_0__から始めましょう