Functions と設定

Updater Plugin Config

See the 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”の”autoUpdate”の文字列モードを使用してください。- 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	デバッグ/テスト用にアップデートメニューを表示するために 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()
• インターフェイス
• Type Aliases

Methods

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

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

Returns: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

アプリの更新URLを設定します。このURLは、更新を確認するために使用されます。

パラメータ	種類	説明
options	UpdateUrl	__CAPGO_KEEP_0__

Since: 5.4.0

---

__CAPGO_KEEP_1__

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

__CAPGO_KEEP_3__

アプリのstatsUrlを設定します。この値は統計情報を送信するために使用されます。空の文字列を渡すと統計情報の収集が停止されます。	パラメータ	種類
options	StatsUrl	__CAPGO_KEEP_0__を使用するURLを含みます。

Since: 5.4.0

---

setChannelUrl(…)

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

,

,	,	,
options	ChannelUrl	,

, 5.4.0

---

,

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

指定されたURLから新しいバンドルをダウンロードします。zipファイルで、内部にファイルが入ったり、ユニークIDが付いたファイルが入ったりします。

パラメーター	タイプ	説明
options	DownloadOptions	ダウンロードする新しいバンドルzipのための{@link DownloadOptions}。

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

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

パラメータ	型	説明
options	BundleId	IDを指定した{@link}のバンドルを削除するためのオブジェクトです (注意: このIDはバンドル名ではなくバンドルIDです) list(…)「list(…）」というタイトルのセクション

---

コピー

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

Type

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

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

---

戻り値:

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

コピー builtin アプリを

Apple App Store / Google Play Store から送信されたバンドルまたは最後に正常に読み込まれたバンドルにリセットします。	パラメーター	型
options	ResetOptions	説明 ResetOptions.toLastSuccessful}, true リセットオプションの最後の成功 false will reset to the last successfully loaded bundle.

---

現在()

current() => Promise<CurrentBundleResult>

Get the current bundle, if none are set it returns builtin. currentNative is the original bundle installed on the device

Returns: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

再読み込み

---

__CAPGO_KEEP_0__

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

Pluginが更新を遅延させるために使用する条件の配列を設定します。 すべての条件が満たされた後、通常の更新プロセスが再び実行され、バックグラウンド化またはアプリを殺すと更新がインストールされます。 「kind」は、ISO 8601形式の日付文字列でなければなりません。 「kind」は、ミリ秒単位の数値でなければなりません。 「kind」は、バージョン番号でなければなりません。 「kind」は使用されません。 このオプションは、killオプションが最初のkill後に更新をトリガーするのではなく、次のバックグラウンド後に更新をトリガーするように動作する不一致があります。この不一致は、将来のメジャー リリースで修正されます。 Param__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>

キャンセル キャンセルキャンセル

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>

__CAPGO_KEEP_0__のプラグイン管理されたローカルチャンネルをこのデバイスに設定します。チャンネルは allow_device_self_set で有効になっている必要があります。

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

重要な注意事項:

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

Type	説明	{@link SetChannelOptions} を設定するチャンネルを指定します。
options	SetChannelOptions	戻り値: バージョン:unsetChannel(…)

「unsetChannel(…）」というセクション Promise<ChannelRes>

Since: __CAPGO_KEEP_0__ 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).

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

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

Type	Since:
options	UnsetChannelOptions

getChannel() 4.7.0

---

getChannel() のセクション

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

範囲: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

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

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

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

Param	Type	Description
options	SetCustomIdOptions	は{@link SetCustomIdOptions}のカスタムIDを設定します

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Returns: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

Returns: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

Returns: Promise<PluginVersion>

---

自動更新有効かどうか()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

戻り値: Promise<AutoUpdateEnabled>

---

すべてのリスナーを削除します。

removeAllListeners() => Promise<void>

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

バージョン: 1.0.0

---

ダウンロードイベントにリスナーを追加します。

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>

パラメーター

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

戻り値: Promise<PluginListenerHandle>

期間: 4.0.0

---

addListener(‘updateAvailable’, …)を呼び出す

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

アプリ起動時に毎回チェックしたい場合に利用できる、更新が利用可能なイベントをリスンする

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

戻り値: Promise<PluginListenerHandle>

期間: 4.0.0

---

addListener(‘downloadComplete’, …)を呼び出す

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

クリップボードにコピー

ダウンロード完了イベントを待ち受けます。	Param
eventName	’downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

Type Promise<PluginListenerHandle>

Returns: 4.0.0

---

Since:

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

クリップボードにコピー

アプリ内でメジャーアップデートイベントを待ち受けます。メジャーアップデートが自動更新でブロックされると知らせます。	Param、Type
eventName	’majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

戻り値: Promise<PluginListenerHandle>

期間: 2.3.0

---

updateFailed イベントにリスナーを追加する（…）

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

アプリ内で update fail イベントをリスンし、更新が次のアプリ起動時に失敗したことを知らせる

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

戻り値: Promise<PluginListenerHandle>

期間: 2.3.0

---

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

---

リスナーを追加(‘appReady’, …)

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

アプリが使用可能になるまで待機するリスナーをAppに追加します。

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

戻り値: Promise<PluginListenerHandle>

Since: 5.1.0

---

自動更新が利用可能かどうかを確認する

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>

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

Param	Type	説明
options	SetShakeMenuOptions	シェイクメニューを有効/無効にするためのboolean値を含む

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

シェイクメニューの現在の状態を取得する

戻り値: Promise<ShakeMenuEnabled>

Since: 7.5.0

---

インターフェイス

AppReadyResult

プロパティ	型
bundle	BundleInfo

BundleInfo

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

UpdateUrl

プロパティ	型
url	string

StatsUrl

プロパティ	型
url	string

ChannelUrl

プロパティ	型
url	string

ダウンロードオプション

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

プロパティ	型	説明	デフォルト	Since
url	string	GitHub/nameバンドルのバージョン
version	string	codeバンドルのURLのzipファイル(例: dist.zip)をダウンロードする。 (これは任意のURLになります。 例: Amazon S3、codeタグ、バンドルをホストしている任意の場所)
sessionKey	string	__CAPGO_KEEP_0__バンドルのバージョン	undefined	4.0.0
checksum	string	__CAPGO_KEEP_0__バンドルをアップデートするためのセッションキー	undefined	4.0.0
manifest	ManifestEntry[]	__CAPGO_KEEP_0__アップデートのチェックサム、sha256で暗号化され、プライベートキーで暗号化されている	undefined	6.1.0

Delta (manifest) マルチファイルダウンロードのマニフェスト

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

BundleId

プロパティ	型
id	string

BundleListResult

プロパティ	型
bundles	BundleInfo[]

ListOptions

プロパティ	型	説明	デフォルト	Since
raw	boolean	raw bundle リストまたはマニフェストを返すかどうかを指定します。true の場合、リストは内部データベースを読み取るのではなく、ディスク上のファイルを読み取るようにします。	false	6.14.0

ResetOptionsセクション

型	CurrentBundleResult
toLastSuccessful	boolean

__CAPGO_KEEP_0__

プロパティ	型
bundle	BundleInfo
native	string

MultiDelayConditionsセクション

型	DelayCondition
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

Prop	Type	概要	Since
status	string	チャンネルの現在の状態	4.7.0
error	string
message	string

SetChannelOptions

Prop	Type
channel	string
triggerAutoUpdate	boolean

SetChannelOptionsを解除

Prop	Type
triggerAutoUpdate	boolean

SetChannelOptionsを解除

Prop	Type	GetChannelResの説明	現在
channel	string	チャンネルを取得するための現在の状態	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

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

ChannelInfo

Prop	種類	説明	__CAPGO_KEEP_0__
id	number	__CAPGO_KEEP_0__	7.5.0
name	string	__CAPGO_KEEP_0__	7.5.0
public	boolean	__CAPGO_KEEP_0__ unsetChannel()__CAPGO_KEEP_0__	7.5.0
allow_self_set	boolean	__CAPGO_KEEP_0__ setChannel()__CAPGO_KEEP_0__	7.5.0

__CAPGO_KEEP_0__ name__CAPGO_KEEP_0__ id.

__CAPGO_KEEP_0__

プロパティ	型
customId	string

バージョン

プロパティ	型
version	string

デバイスID

プロパティ	型
deviceId	string

プラグインバージョン

プロパティ	型
version	string

自動更新有効

プロパティ	型
enabled	boolean

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

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

__CAPGO_KEEP_0__

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

不要イベント

型	説明	バージョン	__CAPGO_KEEP_0__
bundle	BundleInfo	ダウンロードの進行状況、0から100の間。	4.0.0

UpdateAvailableEvent

Prop	Type	説明	Since
bundle	BundleInfo	ダウンロードの進行状況、0から100の間。	4.0.0

DownloadCompleteEvent

Prop	Type	概要	Since
bundle	BundleInfo	新バージョンが利用可能になったときに発生します。	4.0.0

MajorAvailableEvent

Prop	Type	概要	Since
version	string	新バージョンの大規模パッケージが利用可能になったときに発生します。	4.0.0

UpdateFailedEvent

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

DownloadFailedEvent

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

保留中: バンドルはまだ準備中 SET 次のバンドルとして設定します。 ダウンロード中: バンドルがダウンロード中です。 成功: バンドルがダウンロードされ、使用可能になりました。 SET 次のバンドルとして設定します。 エラー: バンドルをダウンロードできませんでした。

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

DelayUntilNext

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

Functions and settingsから続けて

Capgoを使用している場合 Functions and settings ダッシュボードとAPIの操作を計画するのに使用している場合、APIを Using @capgo/capacitor-updater @capgo/capacitor-updaterのネイティブ機能について APIの概要 @APIの概要の実装詳細について 導入 @__CAPGO_KEEP_0__のキーの実装詳細について、 API Keys @APIの実装詳細についてデバイス、 ページを編集 前