設定

更新システムの詳細な制御を実現するには、次の設定を使用して構成します。

ヒント

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

注意

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。 を参照してください.

allowModifyUrl

セクションのタイトル “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

Configure whether the plugin should automatically delete failed bundles.

Available on Android, iOS, and Electron.

Default: true

capacitor.config.json

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

autoDeletePrevious

Configure whether the plugin should automatically delete previous bundles after a successful update.

Default:

Default: true

capacitor.config.json

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

autoSplashscreen

インスタント適用モードを使用する際のスプラッシュスクリーン非表示処理を自動で行う。有効にすると、更新が適用されたり、更新が必要ない場合にスプラッシュスクリーンを自動で非表示にすることができます。 この機能により、手動でアプリが読み込まれた際にスプラッシュスクリーンを非表示にする必要がなくなります。 ただし、以下の条件を満たす場合にのみ機能します。 autoUpdate に設定されている場合、または "atInstall", "onLaunch"、または "always". Legacy directUpdate は既存のバージョンで使用できるため、互換性のためにサポートされます。 @capacitor/splash-screen プラグインがインストールされ、launchAutoHide: false で構成されている必要があります。 Auto Update が有効になっている必要があります。

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

デフォルト: false

capacitor.config.json

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

autoUpdate

プラグインが自動更新を使用する方法を設定します。 true 古いバージョンの互換性のために、真偽値はまだサポートされています: "atBackground" 「true」は「」と同じです。 false 「false」は「」と同じです。 "off".

オプション:

• "off" 自動更新を無効にする falseアプリがバックグラウンドに移動したときに自動でチェックダウンロードして適用する
• "atBackground" インストールやネイティブアプリの更新後にのみ適用する true起動時にのみ適用する
• "atInstall"__CAPGO_KEEP_0__ "atBackground"
• "onLaunch"__CAPGO_KEEP_1__ "atBackground" after the launch check
• "always": 即時適用Auto Updateの実行時
• "onlyDownload": Check and download automatically, emit updateAvailable,自動で確認しダウンロードする、

,自動で次のバンドルを設定しない

Android、iOS、Electronで利用可能です。 "atBackground" (true is still accepted)

Capgoの設定ファイルはcapacitor.config.jsonです。

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

channelUrl

チャネル操作用のURL/エンドポイントを設定します。

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

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

capacitor.config.json

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

defaultChannel

アプリのデフォルトチャンネルをconfigで設定します。ケースシティです。 この設定は、クラウドで設定されたデフォルトチャンネルを上書きしますが、クラウドで設定されたオーバーライドを尊重します。

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

Default: undefined

capacitor.config.json

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

directUpdate

廃止。代わりに「string modes」を使用してください: autoUpdate string modes "atInstall", "onLaunch"、または "always"既存のアプリ用に残されたままです。

オプション:

• false: 直接更新しない
• 'atInstall': autoUpdate: "atInstall"
• 'onLaunch': autoUpdate: "onLaunch"
• 'always': autoUpdate: "always"
• true: (廃止) 「常に」と同じ

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

デフォルト: false

capacitor.config.json

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

disableJSLogging

JavaScript ロギングをプラグインが無効にする。trueの場合、プラグインはJavaScriptコンソールにログを出さない。Nativeログのみが行われる。

Android、iOS、Electronで利用可能。

デフォルト: false

capacitor.config.json

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

keepUrlPathAfterReload

URLパスをリロード後に維持するプラグインの設定を構成します。

注意

リロードがトリガーされたときに、’window.history’がクリアされる。

Android、iOS、Electronで利用可能。

Default: false

capacitor.config.json

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

periodCheckDelay

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

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

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

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で利用可能です。 "" に設定すると、統計レポートを無効にします。

デフォルト: https://plugin.capgo.app/stats

capacitor.config.json

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

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

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

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

Default: undefined

capacitor.config.json

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

ヒント

__CAPGO_KEEP_0__の追加設定は Capgo web アプリ __CAPGO_KEEP_0__の設定は、チャンネルごとに変更できるので、ネイティブ アプリのリリースが必要なくなる。

設定から続ける

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