Functionsと設定

アップデートプラグイン設定

「Github」を参照してください。 詳細はREADMEに記載されています。 README

CapacitorUpdaterを設定するには、次のオプションを使用できます:

プロパティ	タイプ	説明	デフォルト	バージョン
appReadyTimeout	number	Android、iOS、Electronで利用可能な更新のタイムアウト時間をミリ秒単位で指定します。	10000 // (10 seconds)
responseTimeout	number	Configure the number of milliseconds the native plugin should wait before considering API timeout. Available on Android, iOS, and Electron.	20000 // (20 seconds)
autoDeleteFailed	boolean	Android、iOS、Electronで利用可能な失敗したバンドルの自動削除を有効/無効にします。	true
autoDeletePrevious	boolean	Android、iOS、Electronで利用可能な前のバンドルの自動削除を有効/無効にします。	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	Android、iOS、Electronで利用可能なAuto Updateの設定を指定します。trueは「atBackground」と同じ、falseは「off」と同じです。 - off: Auto Updateを無効にします。 - atBackground: アプリがバックグラウンドに移動するときに自動で適用します。 - atInstall: アプリが新しくインストールされたときまたはネイティブアプリが更新されたときにのみ自動で適用します。 - onLaunch: アプリが起動したときに自動で適用します。 - always: Auto Updateが実行されたときに自動で適用します。 - onlyDownload: アプリがバックグラウンドに移動するときに自動でダウンロードし、更新が可能になったときに通知しますが、次のバンドルを自動で設定しません。	”atBackground” // true is still accepted
resetWhenUpdate	boolean	Android、iOS、Electronで利用可能な前のダウンロードしたバンドルの自動削除を有効/無効にします。	true
updateUrl	string	Android、iOS、Electronで利用可能なURL / エンドポイントを更新チェックに送信するように設定します。	https://plugin.capgo.app/updates
channelUrl	string	Android、iOS、Electronで利用可能なチャンネルオペレーションのURL / エンドポイントを設定します。	https://plugin.capgo.app/channel_self
statsUrl	string	Android、iOS、Electronで利用可能な更新統計を送信するURL / エンドポイントを設定します。統計の報告を無効にするには、""に設定します。	https://plugin.capgo.app/stats
publicKey	string	Android、iOS、Electronで利用可能なエンドツーエンドライブアップデート暗号化のバージョン2の公開鍵を設定します。	undefined	6.2.0
version	string	Android、iOS、Electronで利用可能なアプリの現在のバージョンを設定します。このバージョンは、最初の更新要求で使用されます。値を設定しない場合は、プラグインはネイティブのcodeからバージョンを取得します。	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	非推奨。代わりに “atInstall”、 “onLaunch”、または “always” の文字列モードを使用してください。このオプションは既存のアプリ向けにサポートされます。- false: 直接更新を実行しない - atInstall: autoUpdate: “atInstall”と同じ - onLaunch: autoUpdate: “onLaunch”と同じ - always: autoUpdate: “always”と同じ - true: “always”と同じバックグラウンド互換性のためにサポートされます。Android、iOS、Electronで利用可能です。	false	5.1.0
autoSplashscreen	boolean	自動でスプラッシュスクリーンを非表示にすることができます。インスタント適用モードを使用する場合に有効にすることで、更新が適用された後または更新が必要ない場合に自動的にスプラッシュスクリーンを非表示にすることができます。この機能を使用することで、appReadyイベントを手動でリスンし、SplashScreen.hide()を呼び出す必要がなくなります。ただし、autoUpdateが“atInstall”、“onLaunch”、または“always”に設定されている場合にのみ機能します。LEGACYのdirectUpdate値は、バックワード互換性のためにまだサポートされています。@capacitor/splash-screenプラグインがインストールされ、launchAutoHideがfalseに設定されている場合にのみ機能します。Auto Updateが有効になっている必要があります。AndroidとiOSで利用可能です。	false	7.6.0
periodCheckDelay	number	期間更新チェックの待機期間を設定できます。単位は秒です。Android、iOS、Electronで利用可能です。600秒 (10分) 未満には設定できません。	600 // (10 minutes)
localS3	boolean	ローカルサーバーまたは自社の更新サーバーを使用するように CLI を設定できます。	undefined	4.17.48
localHost	string	ローカルサーバーまたは自社の更新サーバーを使用するように CLI を設定できます。	undefined	4.17.48
localWebHost	string	ローカルサーバーまたは自社の更新サーバーを使用するように CLI を設定できます。	undefined	4.17.48
localSupa	string	ローカルサーバーまたは自社の更新サーバーを使用するように CLI を設定できます。	undefined	4.17.48
localSupaAnon	string	ローカルサーバーを使用するように CLI を設定できます。	undefined	4.17.48
localApi	string	Configure the CLI to use a local api for testing.	undefined	6.3.3
localApiFiles	string	Configure the CLI to use a local file api for testing.	undefined	6.3.3
allowModifyUrl	boolean	JavaScript側からupdateUrl、statsUrl、channelUrlを動的に変更することを許可します。	false	5.4.0
defaultChannel	string	アプリのデフォルトチャンネルを設定します。ケース感受性のある設定です。この設定は、クラウドで設定されたデフォルトチャンネルを上書きしますが、クラウドで行われたオーバーライドを尊重します。	undefined	5.5.0
appId	string	アプリのIDを設定します。	undefined	6.0.0
keepUrlPathAfterReload	boolean	リロード後、URLパスを保持するようにプラグインを設定します。注意: リロードがトリガーされた場合、‘window.history’はクリアされます。	false	6.8.0
disableJSLogging	boolean	JavaScriptのログをプラグインで無効にします。trueの場合、プラグインはJavaScriptコンソールにログを出さなくなり、ネイティブログのみが行われます。	false	7.3.0
shakeMenu	boolean	デバッグ/テスト用にアップデートメニューを表示するためにシェイクジェスチャーを有効にします。	false	7.5.0

例

コピー capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": "onlyDownload",
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

インターフェイス capacitor.config.ts:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: 'onlyDownload',
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

• notifyAppReady()
• setUpdateUrl(...)
• setStatsUrl(...)
• setChannelUrl(...)
• download(...)
• next(...)
• set(...)
• delete(...)
• list(...)
• reset(...)
• current()
• reload()
• setMultiDelay(...)
• cancelDelay()
• getLatest(...)
• setChannel(...)
• unsetChannel(...)
• getChannel()
• listChannels()
• setCustomId(...)
• getBuiltinVersion()
• getDeviceId()
• getPluginVersion()
• isAutoUpdateEnabled()
• removeAllListeners()
• addListener('download', ...)
• addListener('noNeedUpdate', ...)
• addListener('updateAvailable', ...)
• addListener('downloadComplete', ...)
• addListener('majorAvailable', ...)
• addListener('updateFailed', ...)
• addListener('downloadFailed', ...)
• addListener('appReloaded', ...)
• addListener('appReady', ...)
• isAutoUpdateAvailable()
• getNextBundle()
• setShakeMenu(...)
• isShakeMenuEnabled()
• インターフェイス
• Type Aliases

Methods

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

Notify Capacitor Updater that the current bundle is working (a rollback will occur if this method is not called on every app launch) By default this method should be called in the first 10 sec after app launch, otherwise a rollback will occur. Change this behaviour with {@link appReadyTimeout}

Returns: Promise<AppReadyResult>

---

setUpdateUrl(…)

setUpdateUrl(options: UpdateUrl) => Promise<void>

アプリのアップデート用のURLを設定します。このURLを使用して、アプリのアップデートを確認できます。

パラメータ	種類	説明
options	UpdateUrl	更新を確認するために使用する URL を含みます。

Since: 5.4.0

---

setStatsUrl(…)

setStatsUrl(options: StatsUrl) => Promise<void>

アプリの statsUrl を設定します。この値は統計情報を送信するために使用されます。空の文字列を渡すと統計情報の収集が停止されます。

パラメータ	種類	説明
options	StatsUrl	statisticを送信するために使用するURLを含みます。

Since: 5.4.0

---

setChannelUrl(…)

setChannelUrl(options: ChannelUrl) => Promise<void>

アプリのchannelUrlを設定します。この値はchannelを設定するために使用されます。

Param	Type	説明
options	ChannelUrl	channelを設定するために使用するURLを含みます。

Since: 5.4.0

---

download(…)

download(options: DownloadOptions) => Promise<BundleInfo>

指定されたURLから新しいバンドルをダウンロードします。zipファイルで、ファイルの中にファイルが入っているか、または一意のIDが付いたファイルの中にすべてのファイルが入っている

パラメータ	タイプ	説明
options	DownloadOptions	ダウンロードオプションの{@link} ダウンロードオプション}

戻り値 Promise<BundleInfo>

---

次(…)

next(options: BundleId) => Promise<BundleInfo>

アプリが再起動されたときに使用する次のバンドルを設定します。

パラメーター	タイプ	説明
options	BundleId	次のアプリ起動時に使用するバンドルのIDを含みます。{@link} BundleInfo.id}

戻り値: Promise<BundleInfo>

---

set(…)

set(options: BundleId) => Promise<void>

現在のバンドルを設定し、アプリを即座に再起動します。

パラメータ	タイプ	説明
options	BundleId	A {@link} バンドルID} object containing the new bundle id to set as current.

---

delete(…)

delete(options: BundleId) => Promise<void>

Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.

パラメータ	タイプ	説明
options	BundleId	A {@link} BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)

---

list(…)

list(options?: ListOptions | undefined) => Promise<BundleListResult>

アプリ内でローカルにダウンロードしたすべてのバンドルを取得

Param	Type	説明
options	ListOptions	The {@link} リストオプション} でバンドルの一覧を表示

戻り値: Promise<BundleListResult>

---

reset(…)

reset(options?: ResetOptions | undefined) => Promise<void>

アプリを builtin バンドル（Apple App Store / Google Play Store から送信されたもの）または最後に正常に読み込まれたバンドルにリセットします。

パラメーター	タイプ	説明
options	ResetOptions	{@link ResetOptions.toLastSuccessful}, true resetするオプションの最後の成功バンドルに戻します。 false resetするオプションの最後の成功バンドルに戻します。

---

現在の()

current() => Promise<CurrentBundleResult>

現在のバンドルを取得します。設定されていない場合は、デフォルトのバンドルを返します。 builtincurrentNativeはデバイスにインストールされている元のバンドルです。

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

表示を再読み込み

---

setMultiDelay(…)

setMultiDelay(options: MultiDelayConditions) => Promise<void>

条件を含む配列を設定します。Pluginはこの条件を使用してアップデートを遅延させます。 条件がすべて満たされた後、通常のアップデートプロセスが再び実行され、更新はアプリをバックグラウンドで実行したり、アプリを終了したりした後でもインストールされます。 kindの場合、値はISO8601形式の日付文字列でなければなりません。 kindの場合、値はミリ秒単位の数値でなければなりません。 kindの場合、値はバージョン番号でなければなりません。 kindの場合、値は使用されません。 この関数は、killオプションをトリガーしてアップデートを実行するが、最初のkillのみをトリガーし、次のバックグラウンドではアップデートを実行しない不一致の挙動を示します。この挙動は、将来のメジャー リリースで修正されます。 パラメータ__CAPGO_KEEP_0__ date __CAPGO_KEEP_0__ background __CAPGO_KEEP_0__ nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	種類	説明
options	MultiDelayConditions	{@link を含む} MultiDelayConditions} の条件を設定するための

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

キャンセル DelayCondition} を即時更新するために処理します。

Since: 4.0.0

---

getLatest(…)

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

最新バンドルを取得するURLから

パラメーター	タイプ
options	GetLatestOptions

戻り値: Promise<LatestVersion>

Since: 4.0.0

---

setChannel(…)

setChannel(options: SetChannelOptions) => Promise<ChannelRes>

デバイスのローカルチャネルを設定します。このチャネルは allow_device_self_set この機能を使用するには有効にする必要があります。

setChannel() バックエンドとチャネルを検証し、選択したチャネルをデバイス上に保存します。バックエンドのデバイスオーバーライドを作成または更新しないため、Capgo ダッシュボードではデバイスがオーバーライドとして表示されません。ダッシュボードまたはPublic API からのみ作成された割り当てのみ、デバイスオーバーライドUIで表示されます。

重要な注意事項:

• このメソッドを使用して、起動時にチャネルを設定しないでください。代わりに defaultChannel in your Capacitor config instead.
• パブリックチャネルは自分で割り当てることができません。
• チャネルが を呼び出すとエラーが返されます。パブリックチャネルを使用するには、代わりに publicを呼び出してください。デバイスは自動的に対応するパブリックチャネルにフォールバックします。 setChannel() __CAPGO_KEEP_0__ unsetChannel() __CAPGO_KEEP_1__
• 使用 listChannels() を使用して、利用可能なチャンネルを検出し、自身の割り当てを許可するかどうかを確認します。

パラメーター	タイプ	説明
options	SetChannelOptions	{@link SetChannelOptions}チャンネルを設定します。

戻り値: Promise<ChannelRes>

バージョン: 4.7.0

---

unsetChannel(…)

unsetChannel(options: UnsetChannelOptions) => Promise<void>

このデバイスのローカルチャンネルをプラグインが管理しているものをクリアします。このメソッドは、ローカルに保存されているチャンネルのみを削除し、ダッシュボードまたはパブリックの__CAPGO_KEEP_0__デバイスオーバーライドの削除は行いません。 setChannel()このメソッドを呼び出した後、通常のチャンネル優先順位が適用されます: 既存のダッシュボードまたはパブリックのAPIデバイスオーバーライドが優先されます; そうでない場合は、デバイスは条件 (プラットフォーム、デバイスタイプ、ビルドタイプ) に合致するパブリック/デフォルトのチャンネルにフォールバックします。

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

デバイスをデフォルトのアップデートトラックに戻したい場合

• パブリックチャンネルを使用したい場合 (パブリックチャンネルは、ダッシュボードまたはパブリックの__CAPGO_KEEP_0__デバイスオーバーライドを自社で割り当てることはできないため)
• パラメーター setChannel())

タイプ	シーケンス
options	UnsetChannelOptions

getChannel() 4.7.0

---

「getChannel()」のセクション

getChannel() => Promise<GetChannelRes>

このデバイスのチャンネルを取得

戻り値: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

このデバイスで利用可能なすべてのチャンネルをリストします。デバイスの現在の環境 (プラットフォーム、エミュレータ/実機、開発/本番ビルド) に対応し、パブリックまたは自分自身の割り当てを許可するチャンネルを返します。

結果の各チャンネルには以下の情報が含まれます:

• publicこの場合、 trueデフォルトのチャンネル protectedTokens. 自動割り当てを受け付けません。 setChannel(). その代わりに、チャンネル割り当てを削除することで、デバイスは自動的にこのパブリックチャンネルからアップデートを受け取るようになります。 unsetChannel(): If
• allow_self_set, これは true 自動割り当て可能なチャンネル . このチャンネルにデバイスを明示的に割り当てることができます。Returns: setChannel().

Since: Promise<ListChannelsResult>

setCustomId(…) 7.5.0

---

セクション “setCustomId(…)”

setCustomId(options: SetCustomIdOptions) => Promise<void>

このデバイスにカスタムIDを設定する

パラメーター	タイプ	説明
options	SetCustomIdOptions	は {@link} SetCustomIdOptions} のカスタムIDを設定します

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

ネイティブアプリのバージョンまたは設定ファイルに設定されている場合のビルトインバージョンを取得します

戻り値: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

デバイスのユニークIDを取得します (自動更新サーバーに送信されます)

戻り値: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

ネイティブCapacitorアップデートプラグインのバージョンを取得します (自動更新サーバーに送信されます)

戻り値: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

自動更新の状態を取得します。

戻り値: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

このプラグインのすべてのリスナーを削除します。

Since: 1.0.0

---

addListener('download', …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

アプリ内でバンドルダウンロードイベントをリスンします。ダウンロードが開始されたとき、ダウンロード中、ダウンロードが完了したときに1度だけ発火します。このイベントはダウンロード中の進捗率をすべて返します。

パラメーター	タイプ
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

戻り値 Promise<PluginListenerHandle>

バージョン 2.0.11

---

addListener(‘noNeedUpdate’, …)のセクション

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

パラメーター

タイプ	protectedTokens
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘updateAvailable’, …)を追加

addListener(eventName: 'updateAvailable', listenerFunc: (state: UpdateAvailableEvent) => void) => Promise<PluginListenerHandle>

アプリ起動時に毎回チェックしたい場合に利用可能なアップデートイベントをリスンする

パラメーター	タイプ
eventName	’updateAvailable’
listenerFunc	(state: UpdateAvailableEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener(‘downloadComplete’, …)を追加

addListener(eventName: 'downloadComplete', listenerFunc: (state: DownloadCompleteEvent) => void) => Promise<PluginListenerHandle>

ダウンロード完了イベントをリスンします。

パラメーター	タイプ
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

---

addListener(‘majorAvailable’, …)のセクション

addListener(eventName: 'majorAvailable', listenerFunc: (state: MajorAvailableEvent) => void) => Promise<PluginListenerHandle>

パラメーター

タイプ	addListener(‘majorAvailable’, …)
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener('updateFailed', …)を呼び出す

addListener(eventName: 'updateFailed', listenerFunc: (state: UpdateFailedEvent) => void) => Promise<PluginListenerHandle>

アプリ内でアップデート失敗イベントをリスンし、次のアプリ起動時にアップデートがインストールに失敗したことを知らせる

パラメーター	タイプ
eventName	’updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 2.3.0

---

addListener('downloadFailed', …)を呼び出す

addListener(eventName: 'downloadFailed', listenerFunc: (state: DownloadFailedEvent) => void) => Promise<PluginListenerHandle>

アプリ内でダウンロード失敗イベントをリスンし、バンドルのダウンロードが失敗したときに通知する

パラメーター	タイプ
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

---

addListener('appReloaded', …)を呼び出す

addListener(eventName: 'appReloaded', listenerFunc: () => void) => Promise<PluginListenerHandle>

アプリ内でリロードイベントをリスンし、リロードが発生したときに通知する

パラメーター	タイプ
eventName	’appReloaded’
listenerFunc	() => void

戻り値: Promise<PluginListenerHandle>

Since: 4.3.0

---

addListener(‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

アプリが利用可能になったときに発生するイベントをリスンすることができます。

パラメーター	タイプ
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動更新が有効かどうかを取得します (サーバー URL で無効にしない場合)。

戻り値: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

再起動時に使用される次のバンドルを取得します。 戻り値は、次のバンドルが設定されていない場合 null です。

戻り値: Promise<BundleInfo | null>

Since: 6.8.0

---

setShakeMenu(…)

setShakeMenu(options: SetShakeMenuOptions) => Promise<void>

デバッグ/テスト用に shake メニューを有効/無効にする

Param	Type	説明
options	SetShakeMenuOptions	shake メニューを有効/無効にするためのブール値を含む

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

shake メニューの現在の状態を取得する

戻り値: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

インターフェイス

アプリケーション準備結果

プロパティ	型
bundle	BundleInfo

バンドル情報

プロパティ	型
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

更新URL

プロパティ	タイプ
url	string

StatsUrl

プロパティ	タイプ
url	string

ChannelUrl

プロパティ	タイプ
url	string

ダウンロードオプション

サーバーからバンドルをダウンロードするために使用されるURLとバージョンです。バックエンドを使用する場合、すべての情報はメソッドgetLatestによって提供されます。バックエンドを使用しない場合、バンドルのURLとバージョンを提供する必要があります。SessionKeyは、CLIコマンドでバンドルを暗号化した場合、コマンドの結果として受け取る必要があります。

プロパティ	タイプ	説明	デフォルト	バージョン
url	string	バンドルのzipファイルのURL (例: dist.zip) をダウンロードします (任意のURLが可能です。例: Amazon S3、GitHubタグ、バンドルをホストしている任意の場所)。
version	string	The version code/name of this bundle/version
sessionKey	string	アップデートのセッションキー、バンドルがセッションキーで暗号化されている場合	undefined	4.0.0
checksum	string	アップデートのチェックサム、バンドルが暗号化されている場合、SHA256で暗号化されたプライベートキーで	undefined	4.0.0
manifest	ManifestEntry[]	Delta (manifest) マルチファイルダウンロードのマニフェスト	undefined	6.1.0

マニフェストエントリ

プロパティ	型
file_name	string | null
file_hash	string | null
download_url	string | null

バンドルID

プロパティ	型
id	string

バンドルリスト結果

プロパティ	型
bundles	BundleInfo[]

リストオプション

Prop	Type	Description	Default	Since
raw	boolean	true	false	6.14.0

ResetOptions

Prop	Type
toLastSuccessful	boolean

CurrentBundleResult

プロパティ	型
bundle	BundleInfo
native	string

マルチディレイ条件

プロパティ	型
delayConditions	DelayCondition[]

ディレイ条件

プロパティ	型	説明
kind	DelayUntilNext	セットアップ遅延条件をsetMultiDelayに設定
value	string

最新バージョン

プロパティ	型	説明	since
version	string	getLatestメソッドの結果	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

GetLatestOptions

プロパティ	型	説明	デフォルト	Since
channel	string	最新バージョンを取得するためのチャンネルを指定します。チャンネルは ‘self_assign’ を許可している必要があります。	undefined	6.8.0

ChannelRes

プロパティ	タイプ	説明	Since
status	string	設定済みのチャンネルの現在の状態	4.7.0
error	string
message	string

SetChannelOptions

プロパティ	型
channel	string
triggerAutoUpdate	boolean

チャンネル設定オプションの解除

プロパティ	型
triggerAutoUpdate	boolean

チャンネル取得結果

プロパティ	型	説明	Since
channel	string	チャンネル取得の現在の状態	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

Prop	Type	説明	Since
channels	ChannelInfo[]	利用可能なチャンネルのリスト	7.5.0

ChannelInfo

Prop	種類	説明	Since
id	number	数値チャンネルID	7.5.0
name	string	チャンネル名	7.5.0
public	boolean	このチャンネルがデフォルト/フォールバックチャンネルである場合にtrueを指定します。デバイスはパブリックチャンネンに自分で割り当てることはできません。代わりに、デバイスがチャンネルオーバーライドを削除したとき (削除方法は「」参照)、自動的にマッチングするパブリックチャンネルからアップデートを受け取るようになります。 unsetChannel()このチャンネルにデバイスが自分で割り当てることができる場合にtrueを指定します。この機能は、ベータテスト、A/Bテスト、またはオプティンアップデートトラックのために使用されます。	7.5.0
allow_self_set	boolean	チャンネルコマンドはチャンネル「」を使用します。数値チャンネルIDを使用するのではなく。 setChannel()数値	7.5.0

SetCustomIdOptions nameSetCustomIdOptions id.

SetCustomIdOptions

プロパティ	型
customId	string

内部バージョン

プロパティ	型
version	string

デバイスID

プロパティ	型
deviceId	string

プラグインバージョン

プロパティ	型
version	string

自動更新有効

プロパティ	型
enabled	boolean

プラグインリスナーハンドル

型	ダウンロードイベント
remove	() => Promise<void>

プラグインバージョンセクション

プロパティ	型	説明	バージョン
percent	number	ダウンロードの現在の状態、0から100まで。	4.0.0
bundle	BundleInfo

不要イベント

型	説明	バージョン	ダウンロードイベントの現在の状態、0から100まで。
bundle	BundleInfo	ダウンロードの現在のステータス、0から100まで。	4.0.0

アップデート可用イベント

プロパティ	型	説明	Since
bundle	BundleInfo	ダウンロードの現在のステータス、0から100まで。	4.0.0

ダウンロード完了イベント

プロパティ	型	概要	Since
bundle	BundleInfo	新バージョンが利用可能になったときに発生します。	4.0.0

MajorAvailableEvent

プロパティ	型	概要	Since
version	string	新バージョンのメジャーバンドルが利用可能になったときに発生します。	4.0.0

UpdateFailedEvent

プロパティ	型	説明	Since
bundle	BundleInfo	更新がインストールに失敗したときに発行される。	4.0.0

ダウンロード失敗イベント

プロパティ	型	説明	Since
version	string	ダウンロードが失敗したときに発行される。	4.0.0

AppReadyEvent

Prop	Type	説明	Since
bundle	BundleInfo	アプリが使用可能になったときに発行される。	5.2.0
status	string

AutoUpdateAvailable

Prop	Type
available	boolean

SetShakeMenuOptions

Prop	Type
enabled	boolean

ShakeMenuEnabled

Prop	Type
enabled	boolean

Type Aliases

BundleStatus

pending: Bundleは準備中です セット 次のバンドルとして設定します。 ダウンロード中: バンドルがダウンロード中です。 成功: バンドルがダウンロードされ、使用できるようになりました。

‘success’ | ‘error’ | ‘pending’ | ‘downloading’

セット

‘background’ | ‘kill’ | ‘nativeVersion’ | ‘date’

エラー: バンドルをダウンロードできませんでした。

セクション：「次のバンドルまで待機」 機能と設定から続けて to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater Capacitorのネイティブ機能のために@capgo/capacitor-updaterを使用します。 APIの概要 APIの実装詳細のためにAPIの概要を参照してください。 導入 __CAPGO_KEEP_0__の実装詳細のために導入を参照してください。 APIのキー APIの実装詳細のためにAPIのキーを参照してください。 デバイス __CAPGO_KEEP_0__の実装詳細のためにデバイスを参照してください。