Functionsと設定

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

「Github」を参照してください。 Readme 詳細はこちら。

CapacitorUpdaterは次のオプションで構成されます。

プロパティ	型	説明	デフォルト	バージョン
appReadyTimeout	number	Android、iOS、Electronで利用可能な場合、nativeプラグインがアップデートを考慮する前に待つms数を設定します。	10000 // (10 seconds)
responseTimeout	number	Android、iOS、Electronで利用可能な場合、APIタイムアウトを考慮する前に待つms数を設定します。	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: フレッシュインストールまたはネイティブアプリのアップデートの後のみ、すぐに適用します。そうでない場合はatBackgroundを使用します。 - onLaunch: 起動時にすぐに適用します。起動チェック後はatBackgroundを使用します。 - always: Auto Updateが実行されるたびにすぐに適用します。 - onlyDownload: アップデートを自動的にダウンロードし、updateAvailableを発行し、次のバンドルを自動的に設定しません。Android、iOS、Electronで利用可能です。	”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’	Android、iOS、Electronで利用可能なオプションです。直接更新を実行しない場合は “false” を設定します。 “atInstall”、 “onLaunch”、 “always” のいずれかを設定します。 “atInstall” は “autoUpdate” の “atInstall” と同じです。 “onLaunch” は “autoUpdate” の “onLaunch” と同じです。 “always” は “autoUpdate” の “always” と同じです。 “true” を設定すると “always” と同じになります。バックグラウンド互換性のために “true” を設定します。	false	5.1.0
autoSplashscreen	boolean	自動でスプラッシュスクリーンを非表示にすることができます。有効にすると、更新が適用された後または更新が必要ない場合に自動的にスプラッシュスクリーンを非表示にします。この機能は、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	ローカルapiを使用するようにCLIを設定します。	undefined	6.3.3
localApiFiles	string	ローカルファイルapiを使用するようにCLIを設定します。	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	デバッグ/テスト用にアップデートメニューを表示するために shake ゲストを有効にします。	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()
• インターフェイス
• タイプエイリアス

メソッド

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}

戻り値: 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が付いたファイルが入ったりします。

パラメーター	タイプ	ダウンロードオプション {@link DownloadOptions} の説明です。
options	DownloadOptions	戻り値: 次(…)次の(…)

protectedTokens 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} BundleId} 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} {@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	Containing {@link ResetOptions.toLastSuccessful}, true reset to the built-in bundle and false will reset to the last successfully loaded bundle.

---

current()

current() => Promise<CurrentBundleResult>

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

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

表示を再読み込み

---

setMultiDelay(…)

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

条件を指定してアップデートを遅延させる関数です。 遅延条件遅延条件の配列を指定します。条件がすべて満たされたら、通常のアップデートプロセスが再び実行され、更新がインストールされます。バックグラウンドで実行中またはアプリを終了した場合にアップデートがインストールされるようにします。 date kindの値はISO8601形式の日付文字列で指定します。 background kindの値はミリ秒単位の数値で指定します。 nativeVersion kindの値はバージョン番号で指定します。 kill kindの値は使用されません。

この関数の動作は不一致です。killオプションを指定すると、最初のkill後にアップデートが実行され、次のバックグラウンド後にアップデートが実行されないようにします。これは、将来のメジャー リリースで修正されます。	種類	説明
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 ダッシュボードで作成された割り当てや、API から作成された割り当てのみ、デバイスのオーバーライド UI に表示されます。

重要な注意事項:

• このメソッドを起動時にチャネルを設定するために使用しないでください。代わりに __CAPGO_KEEP_0__ の設定に 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デバイスオーバーライドの削除は行いません。

このメソッドを呼び出した後、通常のチャネル優先順位が適用されます: 既存のダッシュボードまたはパブリックのAPIデバイスオーバーライドが優先されます。そうでない場合は、デバイスは条件に応じてプラットフォーム、デバイスタイプ、ビルドタイプに合ったパブリック/デフォルトのチャネルにフォールバックします。

これは、以下のシナリオで役立ちます:

• デバイスをデフォルトのアップデートトラックに戻したい場合
• パブリックチャネルを使用したい場合 (パブリックチャネルは自社で割り当てることはできません) setChannel())

パラメータ	タイプ
options	UnsetChannelOptions

シーケンス 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

• publicこの場合、 trueデフォルトのチャンネル context. 自動割り当てを使用して割り当てられません。 setChannel(). その代わりに、チャンネル割り当てを削除することで、デバイスが自動的にこのパブリックチャンネルからアップデートを受け取るようになります。 unsetChannel(): その場合、
• 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>

ネイティブアプリのバージョンを取得する、または設定されたconfigでバuiltinバージョンを取得する

戻り値: 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>

パラメーター

タイプ	context
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>

パラメーター

タイプ	addListener(‘appReloaded’, …)
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 メニューを有効/無効にするためのboolean値を含む

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

Type	CurrentBundleResult
toLastSuccessful	boolean

CurrentBundleResult

プロパティ	型
bundle	BundleInfo
native	string

マルチディレイ条件

プロパティ	型
delayConditions	DelayCondition[]

ディレイ条件

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

最新バージョン

プロパティ	型	説明	バージョン
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

GetLatestオプション

プロパティ	型	説明	デフォルト	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

チャンネル取得レスポンス

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

ListChannelsResult

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

ChannelInfo

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

チャンネルコマンドはチャンネル nameを使用します。数字 id.

は使用しません。

プロパティ	型
customId	string

「BuiltinVersion」を設定する

型	「DeviceId」を設定する
version	string

プロパティ

「PluginVersion」を設定する	「BuiltinVersion」
deviceId	string

「DeviceId」

プロパティ	型
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

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

プロパティ	型	説明	バージョン
bundle	BundleInfo	ダウンロード完了イベント	4.0.0

「ダウンロード完了イベント」セクション

型	ダウンロードの進行状況、0から100まで。	概要	Since
bundle	BundleInfo	新バージョンが利用可能になったときに発生します。	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

プロパティ	型	説明	バージョン
bundle	BundleInfo	更新がインストールに失敗したときに発生します。	4.0.0

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

プロパティ	型	説明	バージョン
version	string	ダウンロードが失敗したときに発生します。	4.0.0

AppReadyEvent

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

AutoUpdateAvailable

Prop	Type
available	boolean

SetShakeMenuOptions

プロパティ	型
enabled	boolean

ShakeMenuEnabled

プロパティ	型
enabled	boolean

型の別名

BundleStatus

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

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

セット

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

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

セクション: "次のバンドルまで待つ" 機能と設定から続けて to plan dashboard and API operations, connect it with Capgoを使用している場合、ダッシュボードとcapgoの操作を計画するには、機能と設定を使用してください。機能と設定を使用して、@capgo/capacitor-updaterと接続してください。 Capgoのネイティブ機能のために@capgo/capacitor-updaterを使用します。 APIの概要 Capgoの実装詳細のためにAPIの概要を参照してください。 導入 実装詳細のために導入を参照してください。 APIのキー 実装詳細のためにAPIのキーを参照してください。 デバイス 実装詳細のためにデバイスを参照してください。