設定

更新システムの制御をより細かく行うには、これらの設定を使用して構成できます。

ヒント

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

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

__CAPGO_KEEP_0__.config.jsonを削除するかどうか自動で設定するかどうかを設定します。

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

デフォルト: true

capacitor.config.json

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

autoSplashscreen

直接アップデートを使用する場合に自動でスプラッシュスクリーンを非表示にするようにします。有効にすると、更新が適用されたり、更新が必要ない場合に自動でスプラッシュスクリーンを非表示にすることができます。 この機能は、直接アップデートが「atInstall」、「always」、またはtrueに設定されている場合にのみ機能します。 @capacitor/splash-screen プラグインがインストールされ、launchAutoHideがfalseに設定されている必要があります。 autoUpdateとdirectUpdateが有効になっている必要があります。

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

デフォルト: false

capacitor.config.json

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

autoUpdate

プラグインが自動更新を使用するかどうかを設定します。

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

デフォルト: true

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": false
    }
  }
}

channelUrl

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

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

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

capacitor.config.json

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

defaultChannel

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

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

デフォルト: undefined

capacitor.config.json

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

directUpdate

プラグインが自動更新モードで直接アップデートを実行するときのタイミングを設定します。 アップロードが—deltaフラグで行われる場合、10MB未満のアプリでは効果的です。 10MB以上のアプリやZipファイルのアップデートは、ユーザーにとって遅い可能性があります。

オプション:

• false: アプリ起動時、バックグラウンド時、またはアップデート時は、デフォルトの動作を実行します。
• 'atInstall': アプリがインストールされたとき、ストアからアップデートされたとき、またはアプリが終了したときにのみ、直接アップデートを実行します。
• 'onLaunch': アプリがインストールされたとき、ストアからアップデートされたとき、またはアプリが終了したときにのみ、直接アップデートを実行します。アプリが再起動されたときも同様です。
• 'always': 上記のすべてのケースで直接アップデートを実行します。
• true: (deprecated) Same as “always” for backward compatibility

Android、iOS、Electronで利用可能

デフォルト: false

capacitor.config.json

{
  "plugins": {
    "CapacitorUpdater": {
      "autoUpdate": true,
      "directUpdate": "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"
    }
  }
}

resetWhenUpdate

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

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

Default: true

capacitor.config.json

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

responseTimeout

APIのnativeプラグインがタイムアウトと考えるまでのミリ秒数を設定します。

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

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

Configure the CLI to use a local api for testing.

デフォルト: undefined

capacitor.config.json

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

localApiFiles

ローカルファイルapiを使用してテストするようにCLIを設定してください。

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

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アプリの編集ページ __CAPGO_KEEP_0__