関数と設定

Updater Plugin の設定

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

CapacitorUpdater では以下のオプションを設定できます：

プロパティ	種類	説明	デフォルト	以降
appReadyTimeout	number	アップデートを「失敗」と判定するまでの待機時間をミリ秒単位で設定します。Android、iOS、Electronで利用可能です。	10000 // (10 seconds)
responseTimeout	number	ネイティブプラグインが API をタイムアウトとみなすまで待機するミリ秒数を設定します。Android、iOS、Electronで利用可能です。	20000 // (20 seconds)
autoDeleteFailed	boolean	失敗したbundleを自動的に削除するかどうかを設定します。Android、iOS、Electronで利用可能です。	true
autoDeletePrevious	boolean	アップデート成功後に、以前のbundleを自動的に削除するかどうかを設定します。Android、iOS、Electronで利用可能です。	true
autoUpdate	boolean | ‘off’ | ‘atBackground’ | ‘atInstall’ | ‘onLaunch’ | ‘always’ | ‘onlyDownload’	アップデートサーバー経由のAuto Updateの動作を設定します。trueは「atBackground」と同じ、falseは「off」と同じです。 - off: Auto Updateを無効化 - atBackground: 自動チェックとダウンロードを行い、アプリがバックグラウンドに移行した際に適用 - atInstall: 新規インストールまたはネイティブアプリの更新直後のみ即時適用し、それ以外はatBackgroundを使用 - onLaunch: 起動時に即時適用し、それ以外は起動時チェック後にatBackgroundを使用 - always: Auto Updateが実行されるたびに即時適用 - onlyDownload: 自動でチェックとダウンロードを行い、updateAvailableを発行し、次のbundleを自動的に設定しません。即時適用モード（“atInstall”、“onLaunch”、“always”）は、アップデートでユーザー体験が低下しないよう、--delta を付けてアップロードしてください。AndroidとiOSでは、これらのモードに autoSplashscreen: true と、launchAutoHide: false を設定した @capacitor/splash-screen が必要です。Android、iOS、Electronで利用可能です。	“atBackground” // true is still accepted
resetWhenUpdate	boolean	新しいネイティブアプリのbundleがデバイスにインストールされた際、以前ダウンロードしたbundleを自動的に削除します。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	エンドツーエンドのlive update暗号化 Version 2用の公開鍵を設定します。Android、iOS、Electronで利用可能です。	undefined	6.2.0
version	string	アプリの現在のバージョンを設定します。これは最初のアップデートリクエストに使用されます。設定しない場合、プラグインはネイティブのcodeからバージョンを取得します。Android、iOS、Electronで利用可能です。	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	非推奨。代わりにautoUpdateの文字列モード（“atInstall”、“onLaunch”、“always”）を使用してください。このオプションは既存のアプリで引き続きサポートされます。Instant applyは--deltaを付けてuploadしてください。そうしないとアップデートでユーザー体験が遅くなります。AndroidとiOSでは、これらのモードにはautoSplashscreen: trueと、launchAutoHide: falseを設定した@capacitor/splash-screenが必要です。 - false: 直接アップデートを一切行わない - atInstall: autoUpdate: “atInstall” と同じ - onLaunch: autoUpdate: “onLaunch” と同じ - always: autoUpdate: “always” と同じ - true: 後方互換性のため “always” と同じ。Android、iOS、Electronで利用可能です。	false	5.1.0
autoSplashscreen	boolean	非推奨の directUpdate 値を含む、インスタント適用モード（“atInstall”、“onLaunch”、または “always”）を使用する場合に必須です。@capacitor/splash-screen をインストールし、launchAutoHide: false で設定する必要があります。有効にすると、アップデートの適用後、またはアップデートが不要な場合にプラグインがスプラッシュスクリーンを非表示にします。これにより、appReady イベントを個別にリッスンして SplashScreen.hide() を呼び出す必要がなくなります。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	JavaScript 側から updateUrl、statsUrl、および channelUrl を動的に変更できるようにします。	false	5.4.0
defaultChannel	string	設定ファイルでアプリのデフォルトチャネルを指定します。大文字と小文字を区別します。この設定はクラウドで設定されたデフォルトチャネルを上書きしますが、クラウド側で行われた個別のオーバーライドは尊重されます。	undefined	5.5.0
appId	string	設定ファイルでアプリの app 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()
• インターフェース
• 型エイリアス

メソッド

notifyAppReady()

notifyAppReady() => Promise<AppReadyResult>

現在のbundleが正常に動作していることをCapacitor Updaterに通知します（このメソッドがアプリ起動のたびに呼び出されない場合、ロールバックが発生します）。 デフォルトでは、アプリ起動後10秒以内にこのメソッドを呼び出す必要があります。呼び出されない場合はロールバックが実行されます。 この挙動は {@link appReadyTimeout} で変更可能です。

戻り値: Promise<AppReadyResult>

---

setUpdateUrl(…)

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

アプリのupdateUrlを設定します。これはアップデートの確認に使用されます。

パラメータ	種類	説明
options	UpdateUrl	アップデートの確認に使用するURLが含まれます。

導入バージョン: 5.4.0

---

setStatsUrl(…)

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

アプリのstatsUrlを設定します。これは統計データの送信に使用されます。空の文字列を渡すと、統計の収集が無効になります。

パラメータ	種類	説明
options	StatsUrl	統計データの送信に使用するURLが含まれます。

導入バージョン: 5.4.0

---

setChannelUrl(…)

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

アプリのchannelUrlを設定します。これはチャンネルの設定に使用されます。

パラメータ	種類	説明
options	ChannelUrl	チャンネルの設定に使用するURLが含まれます。

導入バージョン: 5.4.0

---

download(…)

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

指定されたURLから新しいbundleをダウンロードします。zip形式である必要があり、中にファイルが直接含まれているか、または全ファイルを含む一意のIDを持つディレクトリが含まれている必要があります。

パラメータ	種類	説明
options	DownloadOptions	{@link} DownloadOptions} を使用して、新しいbundleのzipをダウンロードします。

戻り値: Promise<BundleInfo>

---

next(…)

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

アプリの再読み込み時に使用される次のbundleを設定します。

パラメータ	種類	説明
options	BundleId	次回のアプリ起動時に設定する次の Bundle の ID が含まれます。{@link BundleInfo.id}

戻り値: Promise<BundleInfo>

---

set(…)

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

現在の bundle を設定し、すぐにアプリをリロードします。

パラメータ	種類	説明
options	BundleId	{@link} BundleId} オブジェクト。現在の bundle id として設定する新しい ID を含みます。

---

delete(…)

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

ネイティブアプリのストレージから指定した bundle を削除します。保存されている Bundle ID を取得するには {@link list} を併用してください。

パラメータ	種類	説明
options	BundleId	{@link} BundleId} 削除するbundleのIDを含むオブジェクト（注意：これはbundle IDであり、バージョン名ではありません）

---

list(…)

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

アプリ内にローカルにダウンロードされたすべてのbundleを取得する

パラメータ	種類	説明
options	ListOptions	{@link ListOptions} (bundle一覧取得用)

戻り値: Promise<BundleListResult>

---

reset(…)

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

アプリを以下にリセットします： builtin bundle（Apple App Store / Google Play Store に送信されたもの）、または最後に正常にロードされた bundle。

パラメータ	種類	説明
options	ResetOptions	{@link ResetOptions.toLastSuccessful} を含む場合、}, true 組み込みの bundle にリセットし、 false 最後に正常にロードされたbundleにリセットされます。

---

current()

current() => Promise<CurrentBundleResult>

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

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

ビューをリロードします

---

setMultiDelay(…)

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

{@link} DelayCondition} 配列を設定します。この配列には、Plugin がアップデートを遅延させるために使用する条件が含まれます。 すべての条件が満たされると、通常通りアップデートプロセスが再開されます。これにより、アプリをバックグラウンドに送るか、終了させた後にアップデートがインストールされます。 date の場合、値は ISO8601形式の日付文字列である必要があります。 background の場合、値はミリ秒単位の数値である必要があります。 nativeVersion の場合、値はバージョン番号である必要があります。 kill の場合、値は使用されません。 この関数には一貫性のない挙動があります。kill オプションは、他のオプションのように次にバックグラウンドに送られた時ではなく、最初の kill 発生後にアップデートをトリガーします。これは将来のメジャーリリースで修正される予定です。

パラメータ	種類	説明
options	MultiDelayConditions	{@link} MultiDelayConditions 配列に含まれる条件を使用して、

導入バージョン: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

{@link} DelayCondition をキャンセルし、アップデートを即座に実行します。

導入バージョン: 4.0.0

---

getLatest(…)

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

update URLから利用可能な最新のbundleを取得します

パラメータ	種類
options	GetLatestOptions

戻り値: Promise<LatestVersion>

導入バージョン: 4.0.0

---

setChannel(…)

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

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

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

重要な注意事項:

• 起動時にチャンネルを設定するためにこのメソッドを使用しないでください。代わりに defaultChannel Capacitor の設定内の
• を使用してください。このメソッドは、アプリが ready 状態になり、ユーザーが操作を行った後（例：ベータプログラムへの参加など）に使用することを想定しています。
• Public チャンネルを自身で割り当てることはできません。 チャンネルが publicとしてマークされている場合、 setChannel() を呼び出すとエラーが返されます。Public チャンネルを使用するには、代わりに unsetChannel() を呼び出してください。デバイスは自動的に一致する Public チャンネルにフォールバックします。
• 使用する listChannels() 利用可能なチャンネルや、セルフアサインが可能かどうかを確認するには、

パラメータ	種類	説明
options	SetChannelOptions	{@link} SetChannelOptions} チャネルを使用して、

戻り値: Promise<ChannelRes>

導入バージョン: 4.7.0

---

unsetChannel(…)

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

このデバイスのプラグイン管理下にあるローカルチャネルを解除します。これにより、 setChannel(); DashboardやPublic API Device Overrideのレコードは削除されません。

このメソッドを呼び出した後は、通常のチャンネル優先順位が適用されます。既存のDashboardまたはPublic API Device Overrideが優先されます。それ以外の場合は、デバイスの条件（プラットフォーム、デバイスタイプ、ビルドタイプ）に一致するパブリック/デフォルトのチャンネルにフォールバックされます。

以下のような場合に便利です：

• デバイスをデフォルトのアップデートトラックに戻したい場合
• パブリックチャンネルを使用したい場合（パブリックチャンネルは setChannel())

パラメータ	種類
options	UnsetChannelOptions

導入バージョン: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

導入バージョン: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

このデバイスで利用可能なすべてのチャンネルを一覧表示します。デバイスの現在の環境（プラットフォーム、エミュレータ/実機、dev/prod ビルド）に互換性があり、公開されているかセルフアサインが許可されているチャンネルを返します。

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

• public: もし true、これは デフォルトチャンネル. 次のコマンドを使用して、自身を割り当てることはできません: setChannel() を使用してチャンネルの割り当てを解除すると、 unsetChannel()、デバイスはこのパブリックチャネルから自動的にアップデートを受信します。
• allow_self_set: もし true、これは セルフアサイン可能なチャネル。以下のメソッドを使用して、デバイスをこのチャネルに明示的に割り当てることができます： setChannel().

戻り値: Promise<ListChannelsResult>

導入バージョン: 7.5.0

---

setCustomId(…)

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

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

パラメータ	種類	説明
options	SetCustomIdOptions	は {@link} SetCustomIdOptions} カスタムIdで設定します

導入バージョン: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

ネイティブアプリのバージョン、または設定されている場合は組み込みのバージョンを取得します

戻り値: Promise<BuiltinVersion>

導入バージョン: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

デバイスを識別するための固有IDを取得します（自動アップデートサーバーに送信されます）

戻り値: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

戻り値: Promise<PluginVersion>

---

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

自動アップデート設定の状態を取得します。

戻り値: Promise<AutoUpdateEnabled>

---

removeAllListeners()

removeAllListeners() => Promise<void>

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

導入バージョン: 1.0.0

---

addListener(‘download’, …)

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

アプリ内のbundleダウンロードイベントをリッスンします。ダウンロード開始時、ダウンロード中、完了時に発火します。 ダウンロード中の進捗率（パーセント）をすべて返します。

パラメータ	種類
eventName	‘download’
listenerFunc	(state: DownloadEvent) => void

戻り値: Promise<PluginListenerHandle>

導入バージョン: 2.0.11

---

addListener(‘noNeedUpdate’, …)

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

アップデート不要のイベントをリッスンします。アプリ起動時に毎回強制的にチェックを行いたい場合に便利です。

パラメータ	種類
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>

downloadComplete イベントをリッスンします。

パラメータ	種類
eventName	‘downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

戻り値: Promise<PluginListenerHandle>

導入バージョン: 4.0.0

---

addListener(‘majorAvailable’, …)

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

アプリ内でメジャーアップデートのイベントをリッスンします。disableAutoUpdateBreaking が設定されている場合、メジャーアップデートがブロックされた際に通知を受け取ることができます。

パラメータ	種類
eventName	‘majorAvailable’
listenerFunc	(state: MajorAvailableEvent) => void

戻り値: Promise<PluginListenerHandle>

導入バージョン: 2.3.0

---

addListener(‘updateFailed’, …)

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

アプリ内でのアップデート失敗イベントをリッスンします。次回のアプリ起動時にアップデートのインストールに失敗したことを通知します。

パラメータ	種類
eventName	‘updateFailed’
listenerFunc	(state: UpdateFailedEvent) => void

戻り値: Promise<PluginListenerHandle>

導入バージョン: 2.3.0

---

addListener(‘downloadFailed’, …)

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

アプリ内でのダウンロード失敗イベントをリッスンします。bundleのダウンロードに失敗した際に通知を受け取れます。

パラメータ	種類
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>

導入バージョン: 4.3.0

---

addListener(‘appReady’, …)

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

アプリの準備完了イベントをリッスンし、アプリが使用可能になったタイミングを通知します

パラメータ	種類
eventName	‘appReady’
listenerFunc	(state: AppReadyEvent) => void

戻り値: Promise<PluginListenerHandle>

導入バージョン: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動アップデートが利用可能かどうかを確認します（serverUrlによって無効化されていない場合）

戻り値: Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

アプリの再読み込み時に使用される次のbundleを取得します。 次のbundleが設定されていない場合はnullを返します。

戻り値: Promise<BundleInfo | null>

導入バージョン: 6.8.0

---

setShakeMenu(…)

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

デバッグやテスト用に、シェイクメニューの有効/無効を切り替えます

パラメータ	種類	説明
options	SetShakeMenuOptions	シェイクメニューの有効/無効を切り替える enabled boolean を含みます

導入バージョン: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

戻り値: Promise<ShakeMenuEnabled>

導入バージョン: 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

DownloadOptions

このURLとバージョンは、サーバーからbundleをダウンロードするために使用されます。バックエンドを利用している場合は、すべての情報がgetLatestメソッドから提供されます。 バックエンドを利用しない場合は、bundleのURLとバージョンを指定する必要があります。CLI encryptコマンドでbundleを暗号化している場合は、SessionKeyが必要です。これらはコマンドの実行結果として取得してください。

プロパティ	種類	説明	デフォルト	以降
url	string	ダウンロードするbundle zipファイルのURL（例: dist.zip）。（Amazon S3、GitHubタグ、bundleをホストしているその他の場所など、任意のURLを指定できます。）
version	string	このbundle/バージョンのversion code/name
sessionKey	string	アップデートのセッションキー（bundleがセッションキーで暗号化されている場合）	undefined	4.0.0
checksum	string	アップデートのチェックサム。sha256形式である必要があります。bundleが暗号化されている場合は、秘密鍵で暗号化してください。	undefined	4.0.0
manifest	ManifestEntry[]	Delta（manifest）のマルチファイルダウンロード用マニフェスト	undefined	6.1.0

ManifestEntry

プロパティ	種類
file_name	string | null
file_hash	string | null
download_url	string | null

BundleId

プロパティ	種類
id	string

BundleListResult

プロパティ	種類
bundles	BundleInfo[]

ListOptions

プロパティ	種類	説明	デフォルト	以降
raw	boolean	生のバンドルリストを返すか、マニフェストを返すかを指定します。true の場合、ディスク上のファイルではなく内部データベースからリストを読み取ろうとします。	false	6.14.0

ResetOptions

プロパティ	種類
toLastSuccessful	boolean

CurrentBundleResult

プロパティ	種類
bundle	BundleInfo
native	string

MultiDelayConditions

プロパティ	種類
delayConditions	DelayCondition[]

DelayCondition

プロパティ	種類	説明
kind	DelayUntilNext	setMultiDelay で遅延条件を設定する
value	string

LatestVersion

プロパティ	種類	説明	以降
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

プロパティ	種類	説明	デフォルト	以降
channel	string	最新バージョンを取得する対象のチャンネル。動作させるには、チャンネルで ‘self_assign’ が許可されている必要があります。	undefined	6.8.0

ChannelRes

プロパティ	種類	説明	以降
status	string	設定されたチャンネルの現在のステータス	4.7.0
error	string
message	string

SetChannelOptions

プロパティ	種類
channel	string
triggerAutoUpdate	boolean

UnsetChannelOptions

プロパティ	種類
triggerAutoUpdate	boolean

GetChannelRes

プロパティ	種類	説明	以降
channel	string	get channel の現在のステータス	4.8.0
error	string
message	string
status	string
allowSet	boolean

ListChannelsResult

プロパティ	種類	説明	以降
channels	ChannelInfo[]	利用可能なチャンネルの一覧	7.5.0

ChannelInfo

プロパティ	種類	説明	以降
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

プロパティ	種類
version	string

DeviceId

プロパティ	種類
deviceId	string

PluginVersion

プロパティ	種類
version	string

AutoUpdateEnabled

プロパティ	種類
enabled	boolean

PluginListenerHandle

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

DownloadEvent

プロパティ	種類	説明	以降
percent	number	ダウンロードの現在の進捗状況（0から100の間）。	4.0.0
bundle	BundleInfo

NoNeedEvent

プロパティ	種類	説明	以降
bundle	BundleInfo	ダウンロードの現在の進捗状況（0から100の間）。	4.0.0

UpdateAvailableEvent

プロパティ	種類	説明	以降
bundle	BundleInfo	ダウンロードの現在の進捗状況（0から100の間）。	4.0.0

DownloadCompleteEvent

プロパティ	種類	説明	以降
bundle	BundleInfo	新しいアップデートが利用可能になったときに発行されます。	4.0.0

MajorAvailableEvent

プロパティ	種類	説明	以降
version	string	新しいメジャーなbundleが利用可能になったときに発行されます。	4.0.0

UpdateFailedEvent

プロパティ	種類	説明	以降
bundle	BundleInfo	アップデートのインストールに失敗したときに発行されます。	4.0.0

DownloadFailedEvent

プロパティ	種類	説明	以降
version	string	ダウンロードに失敗したときに発行されます。	4.0.0

AppReadyEvent

プロパティ	種類	説明	以降
bundle	BundleInfo	アプリが使用可能な状態になったときに発行されます。	5.2.0
status	string

AutoUpdateAvailable

プロパティ	種類
available	boolean

SetShakeMenuOptions

プロパティ	種類
enabled	boolean

ShakeMenuEnabled

プロパティ	種類
enabled	boolean

型エイリアス

BundleStatus

pending: バンドルが次回のバンドルとして SET 設定されるのを待機中です。 downloading: バンドルをダウンロードしています。 success: バンドルのダウンロードが完了し、準備が整いました。 SET を次のbundleとして設定します。 error: bundleのダウンロードに失敗しました。

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

DelayUntilNext

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

Functions and settingsから先に進む

使用している場合 関数と設定 ダッシュボードと API の運用を計画するには、これを次と連携させます @capgo/capacitor-updater を使用する 「@capgo/capacitor-updater を使用する」のネイティブ機能については、 API の概要 「API の概要」の実装の詳細については、 はじめに 「はじめに」における実装の詳細については、 API キー および「API Keys」の実装の詳細については、 デバイス 実装の詳細については Devices を参照してください。