関数と設定

このプラグインのインストール手順と全マークダウンガイドを含む設定プロンプトをコピーします。

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

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

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

プロパティ	型	説明	Default	__CAPGO_KEEP_0__
`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`	Android、iOS、Electronで利用可能なプラグインが自動アップデートを使用するかどうかを設定します。	`true`
`resetWhenUpdate`	`boolean`	Android、iOS、Electronで利用可能なプラグインがデバイスにインストールされた最新のnativeアプリケーションバンドルがインストールされたときに、以前ダウンロードしたバンドルを自動的に削除します。	`true`
`updateUrl`	`string`	Android、iOS、Electronで利用可能なアップデートのチェックは、指定されたURL/エンドポイントに送信されます。	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	Android、iOS、Electronで利用可能なチャンネルオペレーションは、指定されたURL/エンドポイントに送信されます。	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Android、iOS、Electronで利用可能なアップデート統計は、指定されたURL/エンドポイントに送信されます。統計の報告を無効にするには、""に設定してください。	`https://plugin.capgo.app/stats`
`publicKey`	`string`	Android、iOS、Electronで利用可能なエンドツーヘンドライブアップデートの暗号化のための公開鍵を設定します。	`undefined`	6.2.0
`version`	`string`	現在のアプリのバージョンを設定します。このバージョンは、最初のアップデートリクエストに使用されます。設定しない場合は、プラグインはネイティブのcodeからバージョンを取得します。Android、iOS、Electronで利用可能です。	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	プラグインが自動アップデートモードで動作する場合、直接インストールする更新のタイミングを設定します。10MB未満のアプリや、—deltaフラグでアップロードされたアプリには適しています。Zipまたは10MB以上のアプリの場合は、ユーザーにとってアップデートが遅く感じる可能性があります。- false: 直接アップデートを実行しません (デフォルトの動作: 起動時ダウンロード、バックグラウンド時設定) - atInstall: アプリがインストールされたときにのみ直接アップデートを実行し、ストアからアップデートされた場合はデフォルトの動作を実行します - onLaunch: アプリがインストールされたときにのみ直接アップデートを実行し、ストアからアップデートされた場合はデフォルトの動作を実行します - always: 直接アップデートをすべてのケースで実行します (アプリがインストールされたとき、ストアからアップデートされたとき、またはアプリがkillされたとき) - true: (非推奨) “always”と同じ動作を実行します (バックワード互換性のために) Android、iOS、Electronで利用可能です。	`false`	5.1.0
`autoSplashscreen`	`boolean`	自動的にスプラッシュスクリーンを非表示にするには、直接アップデートを使用します。有効にすると、更新が適用された後または更新が必要ない場合に自動的にスプラッシュスクリーンを非表示にすることができます。この機能は、直接アップデートが「atInstall」、「always」、または「true」に設定されている場合にのみ機能します。@capacitor/splash-screen プラグインがインストールされ、launchAutoHide: false で構成されている必要があります。autoUpdate と directUpdate が有効になっている必要があります。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`	ローカルファイル api を使用するように CLI をテスト用に構成します。	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	ローカルファイル __CAPGO_KEEP_1__ を使用するように __CAPGO_KEEP_0__ をテスト用に構成します。	`false`	5.4.0
`defaultChannel`	`string`	JavaScript側からupdateUrl、statsUrl、channelUrlを動的に変更するようにプラグインを許可します。	`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": false,
      "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: false,
      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に通知します (このメソッドを毎回アプリケーション起動時に呼び出さない場合、ロールバックが発生します)。デフォルトでは、アプリケーション起動後10秒以内にこのメソッドを呼び出さないとロールバックが発生します。この挙動を変更するには、{@link appReadyTimeout}を参照してください。

戻り値 Promise<AppReadyResult>

setUpdateUrl(…)

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

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

パラメーター	種類	説明
`options`	`UpdateUrl`	更新を確認するURLを含む。

Since: 5.4.0

setStatsUrl(…)

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

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

パラメーター	種類	説明
`options`	`StatsUrl`	統計を送信するためのURLを含みます。

Since: 5.4.0

setChannelUrl(…)

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

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

Param	Type	説明
`options`	`ChannelUrl`	チャンネルを設定するために使用するURLを含みます。

Since: 5.4.0

download(…)

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

指定されたURLからzipファイルをダウンロードすることができます。zipファイル内またはzipファイル名に一意のIDが含まれている場合、すべてのファイルが含まれます。

パラメーター	タイプ	説明
`options`	`DownloadOptions`	The {@link ダウンロードオプション}

戻り値: 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}オブジェクトが含まれています。新しいバンドルIDを現在のIDとして設定します。

delete(…)

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

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

パラメーター	種類	説明
`options`	`BundleId`	IDを含む{@link "BundleId"}オブジェクトを削除する (注意: このIDはバンドル名ではなくバージョン名ではありません) list(…)セクション「list(…)」

コピー

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

タイプ

説明	IDを含む{@link "ListOptions"}	IDを含むBundleIdオブジェクトを削除する (注意: このIDはバンドル名ではなくバージョン名ではありません)
`options`	`ListOptions`	list(…) セクション「list(…)」バンドルの一覧

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

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

戻り値: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

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

setMultiDelay(…)

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

Sets a {@link DelayCondition} array containing conditions that the Plugin will use to delay the update. After all conditions are met, the update process will run start again as usual, so update will be installed after a backgrounding or killing the app. For the date kind, the value should be an iso8601 date string. For the background kind, the value should be a number in milliseconds. For the nativeVersion kind, the value should be the version number. For the kill kind, the value is not used. The function has inconsistent behavior the option kill do trigger the update after the first kill and not after the next background like other options. This will be fixed in a future major release.

Param	Type	概要
`options`	`MultiDelayConditions`	条件を含む{@link 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>

バージョン: 4.0.0

setChannel(…)

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

このデバイスのチャンネルを設定します。チャンネルは allow_device_self_set 機能するには、このように有効にします。

「重要な注意事項」

Do not use this method to set the channel at boot. Use the __CAPGO_KEEP_0__ instead. defaultChannel あなたの Capacitor 設定に代わりに。
このメソッドは、アプリが準備できた後、ユーザーがアプリに触れた後 (例えば、ベータプログラムに参加した後) に使用することを目的としています。
パブリックチャネルは自分で割り当てることができません。 チャンネルがマークされている場合 public, コールイング setChannel() エラーが返されます。パブリックチャネルを使用するには、 unsetChannel() デバイスは自動的に対応するパブリックチャネルにフォールバックします。
使用 listChannels() チャンネルが利用可能かどうか、また、自分で割り当てることができるかどうかを確認するには、Capacitor CLI を使用します。

パラメーター	タイプ	説明
`options`	`SetChannelOptions`	{@link} チャンネル設定オプションを設定__CAPGO_KEEP_0__チャンネルを設定します。

結果: Promise<ChannelRes>

「以降：」 4.7.0

unsetChannel(…)

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

デバイスのチャネルオーバーライドを解除します。このメソッドを呼び出した後、デバイスは自動的にアップデートを受け取ります。 パブリックチャンネル その条件 (プラットフォーム、デバイスの種類、ビルドの種類) に合致するチャンネル

これは、以下の場合に便利です。

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

パラメーター	タイプ
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

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

Returns: 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を設定

Param	種類	説明
`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>

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

バージョン: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動更新が利用可能かどうかを取得します(サーバーURLによって無効化されていません)

Returns: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

Returns: Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…)

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

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

Param	種類	説明
`options`	`SetShakeMenuOptions`	shake メニューを有効または無効にするためのブール値を含む

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

インターフェイス

AppReadyResult

Prop	プロパティ
`bundle`	`BundleInfo`

BundleInfo

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

UpdateUrl

Prop	プロパティ
`url`	`string`

StatsUrl

Prop	Type
`url`	`string`

ChannelUrl

Prop	Type
`url`	`string`

DownloadOptions

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

Prop	種類	説明	デフォルト	Since
`url`	`string`	ダウンロードするバンドル 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

プロパティ	タイプ
`id`	`string`

BundleListResultのセクション

タイプ	ListOptionsのセクション
`bundles`	`BundleInfo[]`

プロパティ

オプションのリスト	タイプ	説明	デフォルト	Since
`raw`	`boolean`	バンドルのリストを元のリストかマニフェストとして返すかを指定します。trueの場合、リストは内部データベースを読み込もうとしてファイルをディスク上から読むのではなくします。	`false`	6.14.0

リセットオプション

プロパティ	タイプ
`toLastSuccessful`	`boolean`

現在のバンドル結果

プロパティ	種類
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditions

プロパティ	種類
`delayConditions`	`DelayCondition[]`

遅延条件

プロパティ	種類	説明
`kind`	`DelayUntilNext`	遅延条件をセットアップするにはsetMultiDelayを使用します
`value`	`string`

__CAPGO_KEEP_0__	__CAPGO_KEEP_1__	__CAPGO_KEEP_2__	__CAPGO_KEEP_3__
`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オプション

__CAPGO_KEEP_5__	__CAPGO_KEEP_6__	__CAPGO_KEEP_7__	デフォルト値	最新バージョンを取得するためのチャンネル
`channel`	`string`	この機能が動作するためには、チャンネルは ‘self_assign’ を許可する必要があります	`undefined`	6.8.0

ChannelRes

Prop	Type	説明	現在のチャンネルの状態
`status`	`string`	SetChannelOptions	4.7.0
`error`	`string`
`message`	`string`

「SetChannelOptions」

Prop	種類
`channel`	`string`
`triggerAutoUpdate`	`boolean`

__CAPGO_KEEP_0__

プロパティ	種類
`triggerAutoUpdate`	`boolean`

「__CAPGO_KEEP_0__」取得

「__CAPGO_KEEP_0__」取得の種類	プロパティ	種類	説明
`channel`	`string`	バージョン	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

チャンネルの一覧結果

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

チャンネル情報

プロパティ	型	説明	Capgoでは、
`id`	`string`	チャンネル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

SetCustomIdOptions

プロパティ	型
`customId`	`string`

ビルトインバージョン

プロパティ	型
`version`	`string`

デバイスID

プロパティ	型
`deviceId`	`string`

プラグインバージョン

型	自動更新有効
`version`	`string`

自動更新

プロパティ	タイプ
`enabled`	`boolean`

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

プロパティ	タイプ
`remove`	`() => Promise<void>`

ダウンロードイベント

プロパティ	タイプ	ダウンロードイベントの説明	現在
`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

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

プロパティ	種類	説明	バージョン
`bundle`	`BundleInfo`	新しいアップデートが利用可能になったときに発生します。	4.0.0

メジャーアップデートイベント

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

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

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

DownloadFailedEvent

プロパティ	型	説明	バージョン
`version`	`string`	ダウンロードが失敗したときに発生します。	4.0.0

AppReadyEvent

プロパティ	型	説明	__CAPGO_KEEP_0__から
`bundle`	`BundleInfo`	アプリが使用可能になったときに発行される	5.2.0
`status`	`string`

自動更新が利用可能

プロパティ	型
`available`	`boolean`

シェイクメニューの設定

プロパティ	型
`enabled`	`boolean`

シェイクメニューの有効化

プロパティ	タイプ
`enabled`	`boolean`

型別名

バンドルステータス

準備中: バンドルがダウンロード待ちです。 SET ダウンロード中: バンドルがダウンロード中です。 SET ダウンロード完了: バンドルがダウンロードされ、次のバンドルとして使用可能です。

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

DelayUntilNext

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

関数と設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

次の(…)

set(…)

delete(…)

コピー

reset(…)

current()

reload()

setMultiDelay(…)

cancelDelay()

getLatest(…)

setChannel(…)

unsetChannel(…)

getChannel()

listChannels()

setCustomId(…)

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

removeAllListeners()

addListener('download', …)

addListener('noNeedUpdate', …)を追加

リスナーを追加（‘updateAvailable’、…）

リスナーを追加（‘downloadComplete’、…）

メジャーアップデートイベントをリスンする

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

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

アプリ再読み込みイベントをリスンする

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

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

インターフェイス

AppReadyResult

BundleInfo

UpdateUrl

StatsUrl

ChannelUrl

DownloadOptions

マニフェストエントリ

BundleId

BundleListResultのセクション

プロパティ

リセットオプション

現在のバンドル結果

MultiDelayConditions

遅延条件

最新バージョン

getLatestオプション

ChannelRes

「SetChannelOptions」

__CAPGO_KEEP_0__

「__CAPGO_KEEP_0__」取得

チャンネルの一覧結果

チャンネル情報

SetCustomIdOptions

ビルトインバージョン

デバイスID

プラグインバージョン

自動更新

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

ダウンロードイベント

NoNeedEvent

UpdateAvailableEvent

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

メジャーアップデートイベント

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

DownloadFailedEvent

AppReadyEvent

自動更新が利用可能

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