関数と設定

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

「Github」を参照してください。 README for more information.

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

Prop	Type	Description	Default	Since
appReadyTimeout	number	Android、iOS、Electronで利用可能な場合、nativeプラグインがアップデートを‘失敗’と考えるまでのミリ秒数を設定します。	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: フレッシュインストールまたはネイティブアプリのアップデートの後のみ、即座に適用します。 それ以外の場合はatBackgroundを使用します。 - onLaunch: 起動時に即座に適用します。 起動チェック後はatBackgroundを使用します。 - always: Auto Updateが実行されるたびに即座に適用します。 - onlyDownload: アップデートを自動的にダウンロードし、updateAvailableを発行し、次のバンドルを自動的に設定しません。	”atBackground” // true is still accepted
resetWhenUpdate	boolean	__CAPGO_KEEP_0__をインストールしたデバイスに新しいネイティブアプリケーションバンドルがインストールされたときに、以前ダウンロードしたバンドルを自動的に削除します。Android、iOS、およびElectronで利用可能です。	true
updateUrl	string	更新チェックが送信されるURL/エンドポイントを設定します。Android、iOS、およびElectronで利用可能です。	https://plugin.capgo.app/updates
channelUrl	string	チャンネルオペレーションのためのURL/エンドポイントを設定します。Android、iOS、およびElectronで利用可能です。	https://plugin.capgo.app/channel_self
statsUrl	string	更新統計が送信されるURL/エンドポイントを設定します。Android、iOS、およびElectronで利用可能です。統計の報告を無効にするには""に設定してください。	https://plugin.capgo.app/stats
publicKey	string	エンドツーヘンドライブアップデート暗号化のバージョン2のためのパブリックキーを設定します。Android、iOS、およびElectronで利用可能です。	undefined	6.2.0
version	string	アプリの現在のバージョンを設定します。このバージョンは、最初の更新要求で使用されます。設定しない場合は、ネイティブのcodeからバージョンを取得します。Android、iOS、およびElectronで利用可能です。	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	自動的にスプラッシュスクリーンを非表示にするモードを使用する場合に、自動適用モードでスプラッシュスクリーンを非表示にするようにします。有効にすると、更新が適用されたときや更新が必要ないときに自動的にスプラッシュスクリーンを非表示にすることができます。この機能は、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	CLIをローカルapiでテストするように設定します。	undefined	6.3.3
localApiFiles	string	CLIをローカルファイルapiでテストするように設定します。	undefined	6.3.3
allowModifyUrl	boolean	__CAPGO_KEEP_0__を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>

Capacitor アップデータが現在のバンドルが正常に動作していることを通知します (このメソッドがアプリ起動時に呼び出されない場合、ロールバックが発生します) デフォルトでは、アプリ起動後最初の10秒以内にこのメソッドを呼び出す必要があります。そうしないと、ロールバックが発生します。 この動作を変更するには、{@link appReadyTimeout} を参照してください。

戻り値 Promise<AppReadyResult>

---

setUpdateUrl(…)

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

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

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

Since: 5.4.0

---

__CAPGO_KEEP_0__(…)

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

__CAPGO_KEEP_0__を設定すると、アプリの統計を送信するために使用されます。空の文字列を渡すと、統計の収集が無効になります。

パラメータ	種類	説明
options	StatsUrl	__CAPGO_KEEP_0__を使用する統計データの送信用のURLを指定します。

__CAPGO_KEEP_1__から 5.4.0

---

setChannelUrl(…)

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

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

パラメーター	タイプ	説明
options	ChannelUrl	__CAPGO_KEEP_0__を使用するチャンネルを設定するためのURLを指定します。

__CAPGO_KEEP_1__から 5.4.0

---

download(…)

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

指定されたURLから新しいバンドルをダウンロードします。zipファイルで、ファイルが内部に含まれているか、または一意のIDが付いたファイルが内部に含まれている必要があります。

パラメーター	タイプ	説明
options	DownloadOptions	ダウンロードオプション {@link DownloadOptions} を使用して新しいバンドル zip をダウンロードします。

戻り値: 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}オブジェクトが、現在の設定として設定する新しいバンドルIDを含みます。

---

delete(…)

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

指定されたバンドルをネイティブアプリのストレージから削除します。{@link list}を使用して、保存されているBundle IDを取得します。

パラメータ	型	説明
options	BundleId	IDを指定したバンドルを削除するための{@link}オブジェクト BundleIdバンドルID

---

list(…)

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

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

Param	Type	説明
options	ListOptions	The {@link} リストオプション__CAPGO_KEEP_0__

バンドルの一覧を表示するために使用します。 Promise<BundleListResult>

---

戻り値:

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

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

パラメーター	タイプ	説明
options	ResetOptions	このセクションは {@link} を含みます。 ResetOptions.toLastSuccessful}, true __CAPGO_KEEP_0__ false __CAPGO_KEEP_1__

---

__CAPGO_KEEP_2__

current() => Promise<CurrentBundleResult>

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

Returns: Promise<CurrentBundleResult>

---

再読み込み

reload() => Promise<void>

再読み込み

---

__CAPGO_KEEP_0__

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

Pluginが更新を遅延させる条件を設定します。 条件がすべて満たされた後、通常の更新プロセスが再び実行され、バックグラウンド化またはアプリを終了しても更新がインストールされるようになります。 「kind」は、ISO 8601形式の日付文字列でなければなりません。 「kind」は、ミリ秒単位の数値でなければなりません。 「kind」は、バージョン番号でなければなりません。 「kind」は使用されません。 この関数は、オプション「kill」がトリガーを発生させるように動作が不一致です。最初のkill後にではなく、次のバックグラウンド後にトリガーを発生させるように他のオプションと同じように動作するように修正されます。この修正は、将来のメジャー リリースで行われます。 ParamDelayCondition date setMultiDelay(…) background Reload the view nativeVersion Copy to clipboard kill Sets a {link}DelayCondition{/link} array containing conditions that the Plugin will use to delay the update.

For the "kind" parameter, the value should be an iso8601 date string.	タイプ	説明
options	MultiDelayConditions	{@link を含む }条件の配列を設定する MultiDelayConditionsSince:

cancelDelay() 4.3.0

---

cancelDelay() のセクション

cancelDelay() => Promise<void>

キャンセル {@link DelayCondition } を実行して更新を即座に処理します。 cancelDelay()コピー

Since:__CAPGO_KEEP_0__ 4.0.0

---

getLatest(…)

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

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

Param	Type
options	GetLatestOptions

Returns:__CAPGO_KEEP_0__ Promise<LatestVersion>

Since:__CAPGO_KEEP_0__ 4.0.0

---

setChannel(…)

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

このデバイスのチャンネルを設定します。チャンネルは allow_device_self_set で有効になっている必要があります。

重要な注意事項:

• このメソッドを使用して、起動時にチャンネルを設定しないでください。代わりに defaultChannel in your Capacitor config instead.
• アプリが準備され、ユーザーがアプリにインタラクティブに触れた後 (例: ベータプログラムに参加する) にこのメソッドを使用することを目的としています。
• パブリックチャンネルは自分で割り当てることができません。 チャンネルが publicとマークされている場合、 setChannel() を呼び出すとエラーが返されます。パブリックチャンネルを使用するには、 unsetChannel() を呼び出してください - デバイスは自動的に一致するパブリックチャンネルにフォールバックします。
• 使用してください listChannels() 利用可能なチャンネルを確認し、自我割り当てが許可されているかどうかを知る。

Param	Type	説明
options	SetChannelOptions	指定する {@link SetChannelOptions} チャンネル 戻り値:Since:

unsetChannel(…) Promise<ChannelRes>

「unsetChannel(…）」セクション 4.7.0

---

コピー

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

このデバイスのチャネルオーバーライドを解除します。このメソッドを呼び出した後、このデバイスは自動的に、プラットフォーム、デバイスタイプ、ビルドタイプに合致する「public channel」を取得します。 __CAPGO_KEEP_0__ この機能は、以下のシナリオで便利です。

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

• パブリックチャネルを使用したい場合 (パブリックチャネルは自社で割り当てることはできません)
• Param setChannel())

Type	Since:
options	UnsetChannelOptions

getChannel() 4.7.0

---

セクション「getChannel()」

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

• publicもし trueこのデバイスのデフォルトのチャンネル です。このチャンネルに自分自身を割り当てることはできません。Copy to clipboard setChannel(). そのチャンネル割り当てを削除するのではなく、 unsetChannel(), このパブリックチャンネルから自動的に更新を受け取るようにデバイスにします。
• allow_self_set: true, このチャンネルは 自律割り当てチャンネルです。 このチャンネルにデバイスを明示的に割り当てることができます。 setChannel().

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

セットする

パラメータ	型	説明
options	SetCustomIdOptions	は、{@link __CAPGO_KEEP_0__}のカスタムIDを設定しますSince:

getBuiltinVersion() 4.9.0

---

セクション「getBuiltinVersion()」

getBuiltinVersion() => Promise<BuiltinVersion>

戻り値:

is the {@link __CAPGO_KEEP_0__} customId to set Since: getBuiltinVersion() Section titled “getBuiltinVersion()” Copy to clipboard Get the native app version or the builtin version if set in config Returns: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

戻り値: Promise<AutoUpdateEnabled>

---

removeAllListeners()のセクション

removeAllListeners() => Promise<void>

Since:

downloadイベントにリスナーを追加します。 1.0.0

---

addListener('download', ...)のセクション

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

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

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
eventName	’download’
listenerFunc	(state: DownloadEvent) => void

__CAPGO_KEEP_0__ Promise<PluginListenerHandle>

__CAPGO_KEEP_0__ 2.0.11

---

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

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
eventName	’noNeedUpdate’
listenerFunc	(state: NoNeedEvent) => void

addListener(‘noNeedUpdate’, …) 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>

ダウンロード完了イベントを待ち受ける。

Param	Type
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener('majorAvailable', …)を呼び出す。

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

アプリ内でメジャーアップデートイベントを待ち受けることで、メジャーアップデートが自動更新がブロックされないように設定されている場合に知らせることができます。

Param	Type
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

戻り値: Promise<PluginListenerHandle>

Since:__CAPGO_KEEP_0__ 2.3.0

---

addListener(‘updateFailed’, …)

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

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

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

戻り値:__CAPGO_KEEP_0__ Promise<PluginListenerHandle>

Since:__CAPGO_KEEP_1__ 2.3.0

---

addListener(‘downloadFailed’, …)

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

Appでダウンロード失敗イベントをリスンし、バンドルダウンロードが失敗したときに知らせる

Param	Type
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

---

addListener('appReloaded', ...)を追加

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

Appでリロードイベントをリスンし、リロードが発生したときに知らせる

Param	Type
eventName	’appReloaded’
listenerFunc	() => void

Returns: Promise<PluginListenerHandle>

Since: 4.3.0

---

addListener(‘appReady’, …)

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

アプリが使用可能になるまでの準備が整ったときに発生するイベントをリスンする

Param	Type
eventName	’appReady’
listenerFunc	(state: AppReadyEvent) => void

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

コピー

パラメータ	型	説明
options	SetShakeMenuOptions	shake メニューを有効または無効にするために使用されるboolean値が含まれます。

Since: 7.5.0

---

__CAPGO_KEEP_0__()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

__CAPGO_KEEP_0__の現在の状態を取得します。

戻り値: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

インターフェイス

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__	プロパティ
bundle	BundleInfo

型

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

型

プロパティ	種類
url	string

__CAPGO_KEEP_0__

プロパティ	種類
url	string

チャンネルURL

プロパティ	種類
url	string

ダウンロードオプション

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

プロパティ	タイプ	説明	デフォルト	Since
url	string	バンドル zip ファイルの URL (例: dist.zip) をダウンロードする。 (任意の URL になります。例: Amazon S3、GitHub タグ、バンドルをホストしている任意の場所)
version	string	code/バンドルのバージョン名
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

__CAPGO_KEEP_0__

プロパティ	型
id	string

__CAPGO_KEEP_0__

プロパティ	型
bundles	BundleInfo[]

__CAPGO_KEEP_0__

プロパティ	型	説明	デフォルト	Since
raw	boolean	バンドルリストをRAW形式で取得するか、manifest形式で取得するかを選択します。trueの場合、リストは内部データベースを読み込もうとして、ディスク上のファイルを読み込むのではなくします。	false	6.14.0

ResetOptions

プロパティ	型
toLastSuccessful	boolean

現在のバンドル結果

プロパティ	タイプ
bundle	BundleInfo
native	string

__CAPGO_KEEP_0__

プロパティ	タイプ
delayConditions	DelayCondition[]

__CAPGO_KEEP_0__

プロパティ	タイプ	説明
kind	DelayUntilNext	セットアップの遅延条件をセットMultiDelayに
value	string

最新バージョン

プロパティ	型	説明	Since
version	string	最新バージョンを取得するオプション	4.0.0
checksum	string		6
major	boolean
message	string
sessionKey	string
error	string
old	string
url	string
manifest	ManifestEntry[]		6.1

最新バージョンを取得するオプション

型	説明	getLatestメソッドの結果	デフォルト	この機能は
channel	string	最新バージョンの取得に使用するチャンネルは、自身のチャンネンを割り当てる機能を有効にする必要があります。	undefined	6.8.0

ChannelRes

Prop	Type	説明	現在の設定
status	string	SetChannelOptions	4.7.0
error	string
message	string

SetChannelOptions

プロパティ	型
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

プロパティ	型
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

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

ListChannelsResult

プロパティ	型	説明	Since
channels	ChannelInfo[]	利用可能なチャンネルのリスト	7.5.0

ChannelInfo

プロパティ	型	説明	__CAPGO_KEEP_0__から
id	string	チャンネルID	7.5.0
name	string	チャンネル名	7.5.0
public	boolean	__CAPGO_KEEP_0__がtrueの場合、デフォルト/フォールバックチャンネルです。デバイスはパブリックチャンネンに自分で割り当てることができません。代わりに、デバイスがチャンネルオーバーライドを削除するとき（「」を使用して）、自動的にマッチングするパブリックチャンネルから更新を受け取ります。 unsetChannel()__CAPGO_KEEP_0__がtrueの場合、デバイスは「」を使用してこのチャンネルに明示的に自分で割り当てることができます。この機能は、ベータテスト、A/Bテスト、またはオプティンアップデートトラックのために使用されます。	7.5.0
allow_self_set	boolean	SetCustomIdOptions setChannel()「SetCustomIdOptions」セクション	7.5.0

プロパティ

Since	If true, this is a default/fallback channel. Devices cannot self-assign to public channels. Instead, when a device removes its channel override (using ""), it will automatically receive updates from the matching public channel.
customId	string

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	プロパティ
version	string

__CAPGO_KEEP_2__

__CAPGO_KEEP_3__	デバイスID
deviceId	string

__CAPGO_KEEP_4__

__CAPGO_KEEP_5__	型
version	string

自動更新有効

プロパティ	型
enabled	boolean

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

プロパティ	型
remove	() => Promise<void>

ダウンロードイベント

プロパティ	型	概要	Since
percent	number	ダウンロードの進行状況、0から100まで。	4.0.0
bundle	BundleInfo

NoNeedEvent

Prop	Type	概要	Since
bundle	BundleInfo	ダウンロードの進行状況、0から100まで。	4.0.0

UpdateAvailableEvent

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

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

プロパティ	型	説明	Since
bundle	BundleInfo	新しいアップデートが利用可能になったときに発生します。	4.0.0

__CAPGO_KEEP_0__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__	__CAPGO_KEEP_4__	__CAPGO_KEEP_5__
version	string	__CAPGO_KEEP_6__	4.0.0

__CAPGO_KEEP_7__

__CAPGO_KEEP_8__	__CAPGO_KEEP_9__	__CAPGO_KEEP_10__	現在
bundle	BundleInfo	__CAPGO_KEEP_0__	4.0.0

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

プロパティ	型	説明	現在
version	string	__CAPGO_KEEP_0__	4.0.0

アプリケーション起動イベント

プロパティ	種類	説明	__CAPGO_KEEP_0__
bundle	BundleInfo	アプリが使用できるようになったときに発生します。	5.2.0
status	string

自動更新が利用可能

プロパティ	種類
available	boolean

シェイクメニューのオプションを設定

プロパティ	種類
enabled	boolean

ShakeMenu有効

プロパティ	型
enabled	boolean

型のエイリアス

バンドル状態

保留中: バンドルがダウンロード待ちです。 SET ダウンロード中: バンドルがダウンロード中です。 SET 次のバンドルとして。

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

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

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