機能と設定

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

詳しくはGithubを参照してください。 README 詳細情報についてはこちらを参照してください。

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

プロパティ	タイプ	説明	デフォルト	シーケンス
appReadyTimeout	number	アップデートの失敗を検出するために、ネイティブ プラグインが待機するミリ秒数を設定します。Android、iOS、Electronで利用可能です。	10000 // (10 seconds)
responseTimeout	number	Android、iOS、Electronで利用可能な設定: nativeプラグインが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を発行し、次のバンドルを自動設定せずに インスタントアプリケーションモード（“atInstall”、“onLaunch”、“always”）は、—deltaをアップロードしてユーザー体験を遅くしないようにしてください。 AndroidとiOSでは、@capacitor/splash-screenとlaunchAutoHide: falseを使用する必要があります。	“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	エンドツーエンド暗号化のためのパブリックキーを設定する Configure the public key for end to end live update encryption Version 2. Available on Android, iOS, and Electron.	undefined	6.2.0
version	string	アプリの現在のバージョンを設定します。 初回の更新要求で使用されます。 その場合、プラグインはネイティブの code からバージョンを取得します。 Android、iOS、および Electron で利用可能です。	undefined	4.17.48
directUpdate	boolean | ‘always’ | ‘atInstall’ | ‘onLaunch’	使用されていません。 “atInstall”、“onLaunch”、または “always” の代わりに autoUpdate の文字列モードを使用してください。 このオプションは既存のアプリ向けにサポートされます。 Instant apply は —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/スプラッシュスクリーンはインストールおよび構成され、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	アプリの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>

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}

Returns: Promise<AppReadyResult>

---

Returns:

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

Section titled “setUpdateUrl(…)”

Param	Type	概要
options	UpdateUrl	更新を確認するためのURLを含みます。

Since: 5.4.0

---

setStatsUrl(…)

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

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

パラメーター	種類	概要
options	StatsUrl	統計情報を送信するためのURLを含みます。

Since: 5.4.0

---

setChannelUrl(…)

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

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

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

バージョン 5.4.0

---

download(…)

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

提供されたURLから新しいバンドルをダウンロードしてください。zipファイルで、ファイルが内部に含まれているか、または一意のIDが付いたファイルが内部に含まれているか

パラメータ	タイプ	説明
options	DownloadOptions	ダウンロードオプション ダウンロードオプション戻り値

次の… Promise<BundleInfo>

---

コピー

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

ダウンロードオプション

Param	Type	種類
options	BundleId	説明 次のアプリ起動時に設定するBundleのIDを含みます。{@link}

BundleInfo.id Promise<BundleInfo>

---

戻り値:

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

コピーする

Param	Type	概要
options	BundleId	A {@link} BundleId}

---

削除

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

削除

パラメータ	タイプ	概要
options	BundleId	A {@link} バンドルID削除するバンドルのID (注意: バージョン名ではありません)

---

リスト(…)

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

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

パラメーター	タイプ	説明
options	ListOptions	{@link リストオプション}

結果: Promise<BundleListResult>

---

reset(…)

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

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

タイプ	Type	説明
options	ResetOptions	ResetOptions.toLastSuccessful リセットオプションを最後に正常に読み込まれたバンドルにリセットします。}, true リセットオプションをビルトインのバンドルにリセットします。 false 最後に成功で読み込まれたバンドルにリセットされます。

---

current()

current() => Promise<CurrentBundleResult>

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

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

ビューを再読み込み

---

setMultiDelay(…)

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

Pluginがアップデートを遅延させるために使用する条件の配列を設定します。 DelayCondition} date kind、の値はISO8601形式の日付文字列でなければなりません。 For the background kindの場合、値はISO8601形式の日付文字列でなければなりません。 nativeVersion kindの場合、値はミリ秒単位の数値でなければなりません。 kill kindの場合、値はバージョン番号でなければなりません。

Param	Type	Param
options	MultiDelayConditions	{@link} MultiDelayConditions} の条件を設定するための

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

Cancels a {@link} DelayCondition} を即時更新するために処理します。

Since: 4.0.0

---

getLatest(…)

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

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

パラメーター	タイプ
options	GetLatestOptions

戻り値: Promise<LatestVersion>

バージョン: 4.0.0

---

setChannel(…)

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

このデバイスのプラグイン管理チャンネルを設定します。チャンネルは有効でなければなりません allow_device_self_set この機能が機能するには、チャンネルは有効でなければなりません

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

重要な注意事項:

• 起動時にチャンネルを設定するには、このメソッドを使用しないでください。代わりに__CAPGO_KEEP_0__のconfigに記述してください。 defaultChannel Capacitor の設定に追加してください。
• パブリックチャンネルは自分で割り当てることはできません。
• チャンネルが を呼び出すとエラーが返されます。パブリックチャンネルを使用するには public, calling setChannel() を使用して、利用可能なチャンネルと自分で割り当てることができるかどうかを確認してください。 unsetChannel() __CAPGO_KEEP_0__
• Use listChannels() __CAPGO_KEEP_0__

パラメータ	タイプ	詳細
options	SetChannelOptions	関連する SetChannelOptions} チャンネルを設定する

結果: Promise<ChannelRes>

バージョン: 4.7.0

---

unsetChannel(…)

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

このデバイスのローカルチャネルをプラグインが管理しているものをクリアします。このクリアは、ローカルにプラグインが管理しているチャネルを含むものだけです。 setChannel(); これはダッシュボードやパブリック API デバイス オーバーライドの削除を実行しません。

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

これは有用です:

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

パラメーター	タイプ
options	UnsetChannelOptions

Since: 4.7.0

---

「__CAPGO_KEEP_0__」

getChannel() => Promise<GetChannelRes>

「__CAPGO_KEEP_0__」

戻り値: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

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

Returns: Promise<ListChannelsResult>

Since: 7.5.0

---

setCustomId(…)

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

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

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

Since: 4.9.0

---

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

戻り値: Promise<BuiltinVersion>

Since: 5.2.0

---

getDeviceId()

getDeviceId() => Promise<DeviceId>

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

戻り値: Promise<DeviceId>

---

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

Capgoのネイティブ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>

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

パラメータ	タイプ
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

---

イベントリスナーを追加(‘updateAvailable’, …)

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

利用可能なアップデートイベントをリスンする、毎回アプリを起動するとアップデートを強制チェックしたい場合に便利

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

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

---

イベントリスナーを追加(‘downloadComplete’, …)

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

ダウンロード完了イベントをリスンする

パラメータ	タイプ
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

---

イベントリスナーを追加(‘updateFailed’, …)

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

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

パラメーター	タイプ
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>

Since: 4.0.0

---

アプリ再読み込みイベントを追加

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>

アプリが利用可能になったときにイベントをリスンする

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

戻り値 Promise<PluginListenerHandle>

Since 5.1.0

---

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動更新が利用可能かどうかを取得する（サーバーURLによって無効化されていない場合）

戻り値: Promise<AutoUpdateAvailable>

---

__CAPGO_KEEP_0__

getNextBundle() => Promise<BundleInfo | null>

再起動時に使用される次のバンドルを取得します。 戻り値は、次のバンドルが設定されていない場合にnullです。

戻り値: Promise<BundleInfo | null>

バージョン: 6.8.0

---

__CAPGO_KEEP_0__(…)

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

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

パラメータ	種類	説明
options	SetShakeMenuOptions	shakeメニューの有効化/無効化を制御するboolean値

バージョン: 7.5.0

---

shakeメニューの有効化状態を取得する

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

戻り値: Promise<ShakeMenuEnabled>

バージョン: 7.5.0

---

インターフェイス

AppReadyResult

Prop	種類
bundle	BundleInfo

BundleInfo

Prop	種類
id	string
version	string
downloaded	string
checksum	string
status	BundleStatus

UpdateUrl

Prop	種類
url	string

統計URL

プロパティ	タイプ
url	string

ChannelUrl

プロパティ	タイプ
url	string

「チャンネルURL」セクション

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

__CAPGO_KEEP_0__

バンドルID	種類
id	string

プロパティ

バンドルID	種類
bundles	BundleInfo[]

バンドルリスト結果

バンドルID	種類	説明	デフォルト	バージョン
raw	boolean	内部データベースを読み込むか、ディスク上のファイルを読み込むかを選択します。	false	6.14.0

オプションのリセット

現在のバンドル結果	種類
toLastSuccessful	boolean

セクション:オプションのリセット

現在のバンドル結果	種類
bundle	BundleInfo
native	string

MultiDelayConditions

プロパティ	種類
delayConditions	DelayCondition[]

遅延条件

プロパティ	種類	説明
kind	DelayUntilNext	最新バージョン
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	種類	Description	Since
status	string	設定済みのチャンネルの現在の状態	4.7.0
error	string
message	string

SetChannelOptions

Prop	種類
channel	string
triggerAutoUpdate	boolean

__CAPGO_KEEP_0__

未設定チャネルオプション	種類
triggerAutoUpdate	boolean

プロパティ

未設定チャネルオプション	種類	未設定チャネルオプションの説明	Since
channel	string	チャネル取得の現在の状態	4.8.0
error	string
message	string
status	string
allowSet	boolean

チャンネルリスト結果

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

チャンネル情報

プロパティ	タイプ	説明	Since
id	number	数値チャンネルID	7.5.0
name	string	チャンネル名	7.5.0
public	boolean	デフォルト/フォールバックチャンネルである場合、trueを指定します。デバイスはパブリックチャンネンに自分で割り当てることはできません。代わりに、デバイスがチャンネルオーバーライドを削除したとき（ unsetChannel()を使用）、自動的にマッチングするパブリックチャンネルからアップデートを受け取るようになります。	7.5.0
allow_self_set	boolean	デバイスがこのチャンネンに自分で割り当てることができる場合、trueを指定します。この場合、通常、ベータテスト、A/Bテスト、またはオプインアップデートトラックを実行します。 setChannel()チャンネルコマンドはチャンネル	7.5.0

を使用します。数値 nameは使用しません。 id.

SetCustomIdOptions

Prop	種類
customId	string

__CAPGO_KEEP_0__

プロパティ	種類
version	string

デバイスID

プロパティ	種類
deviceId	string

__CAPGO_KEEP_0__

プロパティ	種類
version	string

__CAPGO_KEEP_0__

プロパティ	種類
enabled	boolean

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

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

ダウンロードイベント

プロパティ	種類	説明	バージョン
percent	number	ダウンロードの進行状況（0から100）	4.0.0
bundle	BundleInfo

NoNeedEvent

アップデート可用イベント	種類	説明	バージョン
bundle	BundleInfo	ダウンロードの進行状況（0から100）	4.0.0

API

プロパティ	タイプ	説明	シーケンス
bundle	BundleInfo	ダウンロードの進行状況、0から100まで	4.0.0

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

プロパティ	タイプ	説明	シーケンス
bundle	BundleInfo	新バージョンが利用可能になったときに発行される。	4.0.0

MajorAvailableEvent

Prop	種類	説明	バージョン
version	string	新バージョンのメジャーバンドルが利用可能になったときに発行される。	4.0.0

UpdateFailedEvent

Prop	種類	概要	Since
bundle	BundleInfo	インストールに失敗したときに発生します。	4.0.0

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

プロパティ	種類	概要	Since
version	string	ダウンロードに失敗したときに発生します。	4.0.0

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

プロパティ	タイプ	詳細	シーケンス番号
bundle	BundleInfo	アプリが利用可能になったときに発行される	5.2.0
status	string

自動更新が利用可能

プロパティ	タイプ
available	boolean

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

プロパティ	種類
enabled	boolean

ShakeMenuEnabled

プロパティ	種類
enabled	boolean

型別のエイリアス

バンドルステータス

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

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

DelayUntilNext

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

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

Capgoを使用している場合 機能と設定 ダッシュボードとAPIのオペレーションを計画するために Capgoを使用している場合、@capgo/capacitor-updater Capgoを使用している場合、@capgo/capacitor-updater APIの概要 Capgoの実装詳細についてはAPIの概要を参照してください。 概要 Capgoの実装詳細については概要を参照してください。 APIのキー Capgoの実装詳細についてはAPIのキー、 デバイス Capgoの実装詳細についてはデバイスを参照してください。