Settings

更新システムをよりきめ細かく制御するには、次の設定を使用して更新システムを構成できます。

`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`

directUpdate 使用時のスプラッシュスクリーンの非表示を自動的に処理します。有効にすると、プラグインは更新が適用された後、または更新が必要ない場合に、スプラッシュスクリーンを自動的に非表示にします。これにより、手動で appReady イベントをリッスンして SplashScreen.hide() を呼び出す必要がなくなります。 directUpdate が「atInstall」、「always」、または true に設定されている場合にのみ機能します。 @capacitor/splash-screen プラグインをインストールし、launchAutoHide: false で構成する必要があります。 autoUpdate と directUpdate を有効にする必要があります。

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

デフォルト: false

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

`autoUpdate`

プラグインがアップデートサーバー経由の自動アップデートを使用するかどうかを設定します。

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

デフォルト: true

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

`channelUrl`

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

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

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

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

`defaultChannel`

設定でアプリのデフォルトのチャネルを設定します。大文字と小文字を区別。この設定はクラウドに設定されているデフォルトのチャネルをオーバーライドしますが、クラウドで行われたオーバーライドは引き続き尊重されます。

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

デフォルト: undefined

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

`directUpdate`

プラグインがアップデートを直接インストールするタイミングを設定します。自動更新モードのみ。 10MB 未満のアプリや —delta フラグを使用してアップロードを行う場合はうまく機能します。 10MB を超える ZIP やアプリは、ユーザーの更新に比較的時間がかかります。オプション:

false: 直接更新を行わない (デフォルトの動作を使用: 開始時にダウンロード、バックグラウンド時に設定)
'atInstall': アプリがインストールされている場合のみ直接更新、ストアから更新され、それ以外の場合は directUpdate = false として機能します。
'onLaunch': アプリがインストールされている場合、ストアから更新された場合、またはアプリの強制終了後にのみ直接更新します。それ以外の場合は、directUpdate = false として機能します。
'always': 以前のすべてのケース (アプリのインストール、ストアからの更新、アプリの強制終了後またはアプリの再開後) では直接更新し、directUpdate = false として動作することはありません。
true: (非推奨) 下位互換性のための「always」と同じ

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

デフォルト: false

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

エンドツーエンドのライブアップデート暗号化バージョン 2 の公開キーを設定します。

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

デフォルト: undefined

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

`resetWhenUpdate`

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

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

デフォルト: true

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

`responseTimeout`

API タイムアウトを考慮する前にネイティブプラグインが待機するミリ秒数を構成します。

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

デフォルト: 20 (20 秒)

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

`shakeMenu`

デバッグ/テスト目的で更新メニューを表示するには、シェイクジェスチャを有効にします。

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

デフォルト: false

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

`statsUrl`

更新統計の送信先となる URL / エンドポイントを設定します。

Android、iOS、および Electron で利用可能です。統計レポートを無効にするには、「」に設定します。

デフォルト: 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`

アプリの現在のバージョンを設定します。これは最初の更新リクエストに使用されます。設定されていない場合、プラグインはネイティブコードからバージョンを取得します。

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

デフォルト: undefined

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

開発設定

`localApi`> テストにローカル API を使用するように CLI を構成します。

デフォルト: undefined

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

`localApiFiles`

テストにローカルファイル API を使用するように CLI を構成します。

デフォルト: undefined

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

`localHost`

テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。

デフォルト: undefined

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

`localSupa`

テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。

デフォルト: undefined

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

`localSupaAnon`

テストにローカルサーバーを使用するように CLI を構成します。

デフォルト: undefined

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

`localWebHost`

テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。

デフォルト: undefined

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

Settings

allowModifyUrl

appId

appReadyTimeout

autoDeleteFailed

autoDeletePrevious

autoSplashscreen

autoUpdate

channelUrl

defaultChannel

directUpdate

disableJSLogging

keepUrlPathAfterReload

periodCheckDelay

publicKey

resetWhenUpdate

responseTimeout

shakeMenu

statsUrl

updateUrl

version

開発設定

localApi> テストにローカル API を使用するように CLI を構成します。

localApiFiles

localHost

localSupa

localSupaAnon

localWebHost

`allowModifyUrl`

`appId`

`appReadyTimeout`

`autoDeleteFailed`

`autoDeletePrevious`

`autoSplashscreen`

`autoUpdate`

`channelUrl`

`defaultChannel`

`directUpdate`

`disableJSLogging`

`keepUrlPathAfterReload`

`periodCheckDelay`

`publicKey`

`resetWhenUpdate`

`responseTimeout`

`shakeMenu`

`statsUrl`

`updateUrl`

`version`

`localApi`> テストにローカル API を使用するように CLI を構成します。

`localApiFiles`

`localHost`

`localSupa`

`localSupaAnon`

`localWebHost`