Functionsと設定

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

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

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

プロパティ	型	説明	デフォルト	Since
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’	プラグインがAuto Updateを使用する方法を設定します。trueは「atBackground」と同じであり、falseは「off」と同じです。 - off: Auto Updateを無効化します - atBackground: アプリがバックグラウンドに移動するときに自動でチェックしダウンロードし、適用します - atInstall: フレッシュインストールまたはネイティブアプリのアップデートの場合のみ即座に適用し、他の場合はatBackgroundを使用します - onLaunch: 起動時に即座に適用し、起動チェック後はatBackgroundを使用します - always: Auto Updateが実行されるたびに即座に適用します - onlyDownload: 自動でチェックしダウンロードし、updateAvailableを発行し、次のバンドルを自動設定せずに終了します。 Instant applyモード（「atInstall」、「onLaunch」、「always」）は、—deltaとともにアップロードする必要があります。そうしないと、ユーザー体験が遅くなる可能性があります。 AndroidとiOSでは、autoSplashscreen: trueと@capacitor/splash-screenのlaunchAutoHide: falseが必要です。 Android、iOS、Electronで利用可能です。	“atBackground” // true is still accepted
resetWhenUpdate	boolean	新しいネイティブアプリのバンドルがデバイスにインストールされたときに、自動的に前のダウンロードしたバンドルを削除します。 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” のオートアップデート文字列モードを使用してください。このオプションは既存のアプリ向けにサポートされます。インスタントアップデートの場合、--deltaオプションを使用してアップデートがユーザー体験に影響を与えないようにしてください。AndroidとiOSでは、このモードを使用するにはautoSplashscreen:trueと@capacitor/splash-screenのlaunchAutoHide:falseを設定する必要があります。- false: 直接アップデートを実行しない - atInstall: autoUpdate: “atInstall”と同じ - onLaunch: autoUpdate: “onLaunch”と同じ - always: autoUpdate: “always”と同じ - true: “always”と同じ (バックワード互換性のために)。Android、iOS、Electronで利用可能です。	false	5.1.0
autoSplashscreen	boolean	インスタントアップデートモード（ “atInstall”、 “onLaunch”、または “always” ）や非推奨の直接アップデート値を使用する場合に必須です。@capacitor/splash-screenはlaunchAutoHide:falseでインストールおよび設定されている必要があります。有効にすると、プラグインはアップデートが適用された後またはアップデートが必要ない場合にスプラッシュスクリーンを非表示にします。これにより、手動でアプリが準備されたイベントをリスンし、スプラッシュスクリーンを非表示にする必要がなくなります。AndroidとiOSで利用可能です。	false	7.6.0
periodCheckDelay	number	Android、iOS、Electronで利用可能です。600秒未満の値は設定できません。	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	アプリの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()
• メソッド
• メソッド

Section titled “Examples”

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}

Copy to clipboard Promise<AppReadyResult>

---

Returns:

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

Copy to clipboard

Param	Type	説明
options	UpdateUrl	アップデートの確認用のURLを含みます。

Since: 5.4.0

---

setStatsUrl(…)

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

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

Param	Type	統計情報の送信用のURLを含みます。
options	StatsUrl	Since:

setChannelUrl(…) 5.4.0

---

Copy to clipboard

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

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

パラメーター	タイプ	説明
options	ChannelUrl	channelを設定するためのURLを含みます。

Since: 5.4.0

---

download(…)

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

指定されたURLからzipファイルをダウンロードします。ファイルは内部に配置されているか、ユニークIDが付いたファイルに配置されている必要があります。

パラメータ	タイプ	説明
options	DownloadOptions	新しいバンドル zip をダウンロードするために使用される {@link} DownloadOptions}

戻り値: Promise<BundleInfo>

---

次の…)

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

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

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

戻り値: Promise<BundleInfo>

---

set(…)

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

現在のBundleを設定し、すぐにアプリを再起動します。

パラメーター	種類	説明
options	BundleId	A {@link} {BundleId}}

---

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.

Param	Type	Description
options	BundleId	A {@link} {BundleId}{object}に、削除するバンドルのIDを含む (注意: このIDはバンドルのIDであり、バージョン名ではありません)

---

list(…)

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

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

パラメーター	タイプ	説明
options	ListOptions	リストオプションの詳細です。{@link ListOptions} 戻り値:list(…)

コピー Promise<BundleListResult>

---

reset(…)

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

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

Param	Type	説明
options	ResetOptions	Containing {@link ResetOptions.toLastSuccessful}, true アプリをデフォルトのバンドルにリセットし、最後に正常に読み込まれたバンドルにリセットします。 false Copy to クリップボード

---

current()

current() => Promise<CurrentBundleResult>

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

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

ビューを再読み込みします

---

setMultiDelay(…)

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

{@link}を設定します。 DelayCondition更新を遅延させるために使用するPluginの条件を含む配列を設定します。 条件がすべて満たされた後、通常の更新プロセスが再び実行され、更新はアプリをバックグラウンドで実行したり、アプリを殺したりした後でもインストールされます。 date kindの場合、値はISO8601形式の日付文字列でなければなりません。 background kindの場合、値はミリ秒単位の数値でなければなりません。 nativeVersion kindの場合、値はバージョン番号でなければなりません。 kill kindの場合、値は使用されません。

このオプションは不一致の動作を示します。killオプションがトリガーする更新は最初のkill後に実行され、次のバックグラウンド実行では実行されません。この問題は将来のメジャー リリースで修正されます。	パラメータ	タイプ
options	MultiDelayConditions	説明 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 バックエンドとチャンネルを検証し、選択したチャンネルをデバイス上にローカルに保存します。バックエンドのデバイスオーバーライドを作成または更新しないため、デバイスは__CAPGO_KEEP_0__ダッシュボードに表示されません。ダッシュボードまたはPublic __CAPGO_KEEP_1__からのみ作成された割り当てのみ、デバイスオーバーライドUIに表示されます。

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

重要な注意事項：

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

Param	種類	説明
options	SetChannelOptions	は{@link SetChannelOptions}のチャンネルを設定します

戻り値: Promise<ChannelRes>

バージョン: 4.7.0

---

unsetChannel(…)

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

このデバイスのローカルチャンネルをプラグインが管理しているものをクリアします。このメソッドは、ローカルに保存されているチャンネルを削除しますが、ダッシュボードまたはパブリック __CAPGO_KEEP_0__ デバイスのオーバーライドレコードは削除されません。 setChannel(); it does not delete Dashboard or Public API Device Override records.

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

これは有用です:

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

パラメーター	タイプ
options	UnsetChannelOptions

シnce: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

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

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

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

パラメータ	タイプ	概要
options	SetCustomIdOptions	は、以下のリンクを参照してください SetCustomIdOptionsを設定します

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

Returns: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

戻り値: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Get the native Capacitor Updater plugin version (sent to auto update server)

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

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

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

戻り値: Promise<PluginListenerHandle>

Since: 2.0.11

---

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

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

アプリ起動時に毎回チェックしたい場合に、更新が必要ないイベントをリスンする

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

パラメーター

protectedTokens	種類
eventName	‘downloadComplete’
listenerFunc	(state: DownloadCompleteEvent) => void

戻り値: Promise<PluginListenerHandle>

Since: 4.0.0

---

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

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

アプリ内でメジャーアップデートイベントをリスンし、メジャーアップデートが自動アップデートをブロックする設定でブロックされている場合に知らせる

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

パラメーター

Param	種類
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>

Since: 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動更新が利用可能かどうかを取得します。

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

---

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

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

インターフェイス

Section titled “インターフェイス” Promise<ShakeMenuEnabled>

コピー 7.5.0

---

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

Section titled “isShakeMenuEnabled()”

プロパティ	型
bundle	BundleInfo

BundleInfo

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

UpdateUrl

プロパティ	型
url	string

StatsUrl

プロパティ	タイプ
url	string

「ChannelUrl」セクション

タイプ	「DownloadOptions」セクション
url	string

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

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.

protectedTokens	pagePath	概要	デフォルト	Since
url	string	GitHub バンドル 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

バンドルID

プロパティ	タイプ
id	string

バンドルリスト結果

プロパティ	タイプ
bundles	BundleInfo[]

リストオプション

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

ResetOptions

Prop	Type
toLastSuccessful	boolean

現在のバンドル結果

Prop	Type
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Type
delayConditions	DelayCondition[]

DelayCondition

Prop	Type	Description
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	最新バージョンを取得するためのチャンネル The channel must allow ‘self_assign’ for this to work	undefined	6.8.0

ChannelRes

プロパティ	型	説明	バージョン
status	string	チャンネルの現在の状態	4.7.0
error	string
message	string

SetChannelOptions

プロパティ	型
channel	string
triggerAutoUpdate	boolean

Channelオプションの設定を解除

プロパティ	型
triggerAutoUpdate	boolean

Channel情報の取得

プロパティ	型	説明	バージョン
channel	string	Channelの現在の状態	4.8.0
error	string
message	string
status	string
allowSet	boolean

Channel情報のリスト

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

SetCustomIdOptions

プロパティ	型
customId	string

バンドル内バージョン

プロパティ	型
version	string

デバイスID

プロパティ	型
deviceId	string

プラグインバージョン

プロパティ	型
version	string

自動更新有効

プロパティ	型
enabled	boolean

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

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

ダウンロードイベント

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

NoNeedEvent

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

UpdateAvailableEvent

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

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

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

メジャーアバイルメントイベント

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

アップデート失敗イベント

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

DownloadFailedEvent

Prop	Type	説明	以降
version	string	ダウンロードに失敗したときに発生します。	4.0.0

AppReadyEvent

Prop	種類	説明	Since
bundle	BundleInfo	アプリが使用できる準備が整ったときに発行される。	5.2.0
status	string

AutoUpdateAvailable

プロパティ	種類
available	boolean

SetShakeMenuOptions

プロパティ	種類
enabled	boolean

ShakeMenuEnabled

プロパティ	型
enabled	boolean

型のエイリアス

バンドルステータス

準備中: バンドルが次のバンドルとして準備中です。 SET ダウンロード中: バンドルがダウンロード中です。 SET 次のバンドルに進みます。 エラー: バンドルをダウンロードできませんでした。

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

DelayUntilNext

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

Functions and settingsから続けてください。

あなたが「Functions and settings」を使用している場合 Functions and settings ダッシュボードとAPIの操作を計画する場合、APIを native capabilityのための@capgo/capacitor-updaterを使用します。 native capabilityのための@capgo/capacitor-updaterの実装詳細は、capgo Overview 実装詳細のAPI Overview API Overview 導入 導入の実装詳細のために API キー API キーの実装詳細のために、 デバイス デバイスの実装詳細のために