機能と設定

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

Githubを参照してください README 詳細はこちらです。

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

プロパティ	型	説明	デフォルト	Since
appReadyTimeout	number	nativeプラグインがアップデートを「失敗」したと考えるまでのミリ秒数を設定します。Android、iOS、Electronで利用可能です。	10000 // (10 seconds)
responseTimeout	number	API秒以内にnativeプラグインがタイムアウトを検出するように設定します。Android、iOS、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を発行し、次のバンドルを自動設定せずに - 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”。このオプションは、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	CLIをローカルapiに設定します。	undefined	6.3.3
localApiFiles	string	CLIをローカルファイルapiに設定します。	undefined	6.3.3
allowModifyUrl	boolean	JavaScript側からアップデートURL、統計URL、チャンネルURLを動的に変更できるようにします。	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

例

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

In 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

---

setStatsUrl(…)

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

アプリのstatsUrlを設定します。このURLを使用して統計情報を送信します。統計情報の収集を無効にするには、空の文字列を渡します。

Param	Type	説明
options	StatsUrl	__CAPGO_KEEP_0__を使用して統計情報を送信するためのURLを指定します。

Since: 5.4.0

---

setChannelUrl(…)

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

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

パラメーター	タイプ	チャンネルを設定するために使用するURLを含みます。
options	ChannelUrl	Since:

download(…) 5.4.0

---

セクション「download(…)」

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

すべてのファイル

Param	Type	Description
options	DownloadOptions	The {@link DownloadOptions} for downloading a new bundle zip.

Returns: Promise<BundleInfo>

---

next(…)

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

Set the next bundle to be used when the app is reloaded.

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

戻り値: Promise<BundleInfo>

---

set(…)

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

現在のBundleを設定し、すぐにアプリを再読み込みします。

パラメーター	種類	説明
options	BundleId	A {@link {@link BundleId} object containing the new bundle id to set as current.delete(…)

---

Section titled “delete(…)

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

Param

Type	Description	A {@link BundleId}
options	BundleId	list BundleId指定したバンドルのID (注意: バンドル名ではなくバージョン名ではありません) を含むオブジェクト

---

list(…)

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

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

パラメーター	タイプ	説明
options	ListOptions	バンドルをリストするための {@link ListOptions} オプション 戻り値:ListOptions

Returns: Promise<BundleListResult>

---

reset(…)

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

アプリを builtin 配布用のバンドル（Apple App Store / Google Play Store から配布）または最後に正常に読み込まれたバンドルに戻します。

パラメーター	タイプ	説明
options	ResetOptions	{@link ResetOptions.toLastSuccessful}, true バンドルをリセットし、最後に正常に読み込まれたバンドルに戻します。 false リセットオプションのデフォルト値は、バンドルをリセットし、最後に正常に読み込まれたバンドルに戻します。

---

current()

current() => Promise<CurrentBundleResult>

現在のバンドルを取得します。 builtin. currentNative は、デバイスにインストールされている元のバンドルです。

戻り値: Promise<CurrentBundleResult>

---

reload()

reload() => Promise<void>

再読み込み

---

setMultiDelay(…)

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

{@link DelayConditionPluginが更新を遅延させるために使用する条件の配列を設定します。 すべての条件が満たされた後、更新プロセスは通常通り再開され、更新はアプリをバックグラウンドにしたり、アプリを終了したりした後でもインストールされます。 date kind background iso8601形式の日付文字列 nativeVersion kind kill ミリ秒

kind	バージョン番号	kind
options	MultiDelayConditions	使用されません。 このオプションは不一致の動作を引き起こします。killオプションは最初のkill後に更新をトリガーし、次のバックグラウンドではトリガーしません。これは将来のメジャーリリースで修正されます。 MultiDelayConditions条件を設定するための配列

Since: 4.3.0

---

cancelDelay()

cancelDelay() => Promise<void>

を即座に更新するために、{@link 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__ダッシュボードに表示されません。ダッシュボードまたはパブリック__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.

重要な注意事項：

• 起動時にはこのメソッドを使用しないでください。 __CAPGO_KEEP_0__ の設定に "in your" を使用してください。 defaultChannel in your Capacitor config instead.
• パブリックチャネルは自分で割り当てることができません。
• チャネルが "" としてマークされている場合、チャネルを割り当てるとエラーが発生します。パブリックチャネルを使用するには、"" を呼び出してください - デバイスは自動的にマッチするパブリックチャネルにフォールバックします。 パブリックチャネルを使用するには "" を使用して、利用可能なチャネルと自分で割り当てることができるかどうかを確認してください。 publicパラメータ setChannel() パブリックチャネルを使用するには "" を使用してください。 unsetChannel() パブリックチャネルを使用するには "" を使用してください。
• パブリックチャネルを使用するには "" を使用してください。 listChannels() パブリックチャネルを使用するには "" を使用してください。

パブリックチャネルを使用するには "" を使用してください。	種類	説明
options	SetChannelOptions	{@link を参照してください セットチャネルオプション}チャネルを設定する

戻り値: Promise<ChannelRes>

Since: 4.7.0

---

unsetChannel(…)

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

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

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

This is useful when:

• You want to move a device back to the default update track
• You want to use a public channel (since public channels cannot be self-assigned via setChannel())

Param	Type
options	UnsetChannelOptions

Since: 4.7.0

---

getChannel()

getChannel() => Promise<GetChannelRes>

Get the channel for this device

Returns: Promise<GetChannelRes>

Since: 4.8.0

---

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

• publicもし trueこのチャンネルは デフォルトチャンネルです。自分自身の割り当てを使用して setChannel()できないため、自分自身の割り当てを削除する場合、デバイスは自動的にこのパブリックチャンネルから更新を受け取ることになる。 unsetChannel()__CAPGO_KEEP_0__
• allow_self_set: ならば true, これはあなたの 自律的なチャネルです。 このチャネルにデバイスを明示的に割り当てることができます。 setChannel().

戻り値: Promise<ListChannelsResult>

バージョン: 7.5.0

---

setCustomId(…)

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

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

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

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>

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

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

Param: __CAPGO_KEEP_0__	タイプ
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>

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

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

__CAPGO_KEEP_0__： Promise<PluginListenerHandle>

__CAPGO_KEEP_1__から： 4.0.0

---

addListener('majorAvailable', …)

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

アプリ内でメジャーアップデートイベントをリスンし、メジャーアップデートが自動更新ブロックされると知らせる

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

__CAPGO_KEEP_0__： Promise<PluginListenerHandle>

__CAPGO_KEEP_1__から： 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>

アプリ内でダウンロード失敗イベントをリスンし、バンドルダウンロードが失敗したことを知らせる

パラメーター	種類
eventName	’downloadFailed’
listenerFunc	(state: DownloadFailedEvent) => void

戻り値: Promise<PluginListenerHandle>

以下のバージョンから利用可能: 4.0.0

---

appReloaded イベントにリスナーを追加（…）

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

アプリのリロードイベントをリスンし、リロードが完了したときに通知します

パラメーター	種類
eventName	’appReloaded’
listenerFunc	() => void

戻り値: Promise<PluginListenerHandle>

以下のバージョンから利用可能: 4.3.0

---

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>

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

戻り値： Promise<AutoUpdateAvailable>

---

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

アプリが再読み込みされたときに使用される次のバンドルを取得します。 次のバンドルが設定されていない場合、nullを返します。

戻り値 Promise<BundleInfo | null>

バージョン 6.8.0

---

setShakeMenu(…)

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

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

パラメーター	タイプ	概要
options	SetShakeMenuOptions	__CAPGO_KEEP_0__を有効または無効にするshakeメニューを含む

Since: 7.5.0

---

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

戻り値: 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とバージョンを提供する必要があります。__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.

ダウンロードオプション	バックエンドを使用している場合、getLatestメソッドによって提供される情報を使用してください。バックエンドを使用していない場合、URLとバージョンを指定する必要があります。	概要	デフォルト	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

BundleId

Prop	型
id	string

BundleListResult

Prop	型
bundles	BundleInfo[]

ListOptions

Prop	型	説明	デフォルト	Since
raw	boolean	__CAPGO_KEEP_0__をtrueにすると、リストは内部データベースを読み込むのではなく、ディスク上のファイルを読み込むようになります。	false	6.14.0

オプションのリセット

プロパティ	型
toLastSuccessful	boolean

現在のバンドル結果

プロパティ	型
bundle	BundleInfo
native	string

MultiDelayConditions

Prop	Type
delayConditions	DelayCondition[]

DelayCondition

Prop	Type	説明
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

GetLatestOptions

プロパティ	型	説明	デフォルト	バージョン
channel	string	The channel to get the latest version for __CAPGO_KEEP_0__	undefined	6.8.0

__CAPGO_KEEP_0__ must allow ‘self_assign’ for this to work

__CAPGO_KEEP_2__ titled “__CAPGO_KEEP_1__”	__CAPGO_KEEP_3__	Type	__CAPGO_KEEP_4__
status	string	Since	4.7.0
error	string
message	string

Current status of set __CAPGO_KEEP_0__

__CAPGO_KEEP_6__ titled “__CAPGO_KEEP_5__Options”	__CAPGO_KEEP_3__
channel	string
triggerAutoUpdate	boolean

未設定チャネルオプション

プロパティ	型
triggerAutoUpdate	boolean

チャネル取得結果

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

チャネルリスト結果

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

ChannelInfo

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

__CAPGO_KEEP_5__ name「__CAPGO_KEEP_5__」セクション id.

__CAPGO_KEEP_6__

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

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

UpdateAvailableEvent

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

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

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

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

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

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

プロパティ	型	説明	Since
bundle	BundleInfo	Emit when a update failed to install.	4.0.0

DownloadFailedEvent

Prop	Type	Description	Since
version	string	Emit when a download fail.	4.0.0

AppReadyEvent

Prop	種類	説明	Since
bundle	BundleInfo	アプリが使用可能になったときに発生します。	5.2.0
status	string

AutoUpdateAvailable

プロパティ	種類
available	boolean

SetShakeMenuOptions

プロパティ	種類
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 Capgoを使用してダッシュボードとAPIのオペレーションを計画するには、APIを接続してください @capgo/capacitor-updaterを使用 @capgo/capacitor-updaterを使用してCapgoのネイティブ機能を実装するには APIの概要 Capgoの実装詳細についてはAPIの概要を参照してください Introduction for the implementation detail in Introduction, APIの実装詳細については API Keysの実装詳細については デバイス for the implementation detail in Devices.