関数と設定

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

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

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

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

プロパティ	タイプ	説明	デフォルト	シnce
`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`	Android、iOS、Electronで利用可能な、自動アップデートを使用するかどうかを設定します。	`true`
`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’`	プラグインが自動更新モードで動作する場合にのみ、更新を直接インストールするタイミングを設定します。10MB未満のアプリと、—deltaフラグでアップロードされたアプリには適しています。10MB以上のZipアプリやアプリは、ユーザーにとって更新が遅くなる可能性があります。 - false: 直接更新を実行せず、デフォルトの動作に従う (起動時ダウンロード、バックグラウンドで設定) - atInstall: アプリがインストールされたときにのみ直接更新を実行し、ストアから更新された場合も同様。そうでない場合は、directUpdate = false と同じ動作を実行 - onLaunch: アプリがインストールされたとき、ストアから更新されたとき、またはアプリが終了したときにのみ直接更新を実行し、そうでない場合は、directUpdate = false と同じ動作を実行 - always: 直接更新をすべての前述のケースで実行し、directUpdate = false と同じ動作を実行しない - true: (非推奨) “always”と同じ動作を実行するために、バックグラウンド互換性のために使用される。 Android、iOS、Electronで利用可能。	`false`	5.1.0
`autoSplashscreen`	`boolean`	直接更新を使用する場合に、自動でスプラッシュスクリーンを非表示にするようにプラグインを設定します。有効にすると、更新が適用されたときや更新が必要ないときに、スプラッシュスクリーンを自動的に非表示にします。これにより、appReadyイベントをリスンし、SplashScreen.hide()を呼び出す必要がなくなります。ただし、directUpdateが“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`	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`	デバッグ/テスト用にアップデートメニューを表示するためにシェイクジェスチャーを有効にします。	`false`	7.5.0

例

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

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

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>

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

パラメーター	タイプ	チャンネルの設定に使用するURLを含みます。
`options`	`ChannelUrl`	バージョン

URLから新しいバンドルをダウンロードします。zipファイルで、ファイルが含まれているか、ユニークIDが付いたファイルが含まれている必要があります。 5.4.0

コピー

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

ダウンロード

パラメータ	型	説明
`options`	`DownloadOptions`	The {@link DownloadOptions} を使用して新しいバンドル zip をダウンロードするオプション。

戻り値: 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} object containing the new bundle id to set as current.

delete(…)

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

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

Param	Type	Description
`options`	`BundleId`	A {@link BundleId指定したバンドルのIDを削除する (注意: バンドルのIDはバージョン名ではありません)

list(…)

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

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

Param	Type	説明
`options`	`ListOptions`	指定したバンドルをリストするための {@link ListOptions} 戻り値:ListOptions

The {@link ListOptions} for listing bundles Promise<BundleListResult>

reset(…)

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

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

パラメーター	タイプ	説明
`options`	`ResetOptions`	参照： ResetOptions.toLastSuccessful}, `true` バンドルをリセットし、最後に正常に読み込まれたバンドルにリセットします。 `false` リセットオプションを使用して、バンドルをリセットします。

current()

current() => Promise<CurrentBundleResult>

指定されたバンドルがなければ、デバイスにインストールされている元のバンドルを返します builtin. currentNative は、デバイスにインストールされている元のバンドルです

戻り値: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

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

setMultiDelay(…)

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

{@linkを設定します DelayCondition}配列に条件を含む、プラグインがアップデートを遅延させるために使用する条件が含まれています。すべての条件が満たされた後、通常のアップデートプロセスが再び実行され、背景化またはアプリを終了した後、更新はインストールされます。 "kind"の場合、値はISO8601形式の日付文字列でなければなりません。 "kind"の場合、値はミリ秒単位の数値でなければなりません。 "kind"の場合、値はバージョン番号でなければなりません。 "kind"の場合、値は使用されません。この関数は、オプション"kill"が最初のkill後にアップデートをトリガーし、次の背景化後にアップデートをトリガーしないように不一致な動作を示します。この不一致は、将来のメジャーリリースで修正されます。 date Param background Type nativeVersion 説明 kill {@linkを含む

{@linkを含む	{@linkを含む	{@linkを含む
`options`	`MultiDelayConditions`	{@linkを含む MultiDelayConditions__CAPGO_KEEP_0__

Since: 4.3.0

キャンセル

cancelDelay() => Promise<void>

キャンセル処理 Since:最新情報を取得

キャンセル処理 4.0.0

Section titled “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 重要な注意:

Important notes:

起動時にチャネルを設定しないでください。この方法を使用してください。 defaultChannel Capacitorの設定に
アプリが起動し、ユーザーがアプリに触れた後 (例: ベータプログラムに参加する) に使用することを目的としています。
パブリックチャネルは自分で割り当てることができません。 チャネルが publicの場合、 setChannel() will return an error. To use a public channel, call unsetChannel() instead - the device will automatically fall back to the matching public channel.
Use listChannels() to discover which channels are available and whether they allow self-assignment.

Param	Type	概要
`options`	`SetChannelOptions`	{@link を参照してくださいこのデバイスに設定するチャンネルを設定します戻り値:

バージョン: Promise<ChannelRes>

unsetChannel(…)を呼び出す 4.7.0

セクション「unsetChannel(…)」

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

public channel コピー このデバイスのチャンネルオーバーライドを解除します。このメソッドを呼び出した後、このデバイスは自動的に、プラットフォーム、デバイスタイプ、ビルドタイプに合致する「public channel」から更新を受け取ります。

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

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

Param	Type
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

Since: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

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

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>

__CAPGO_KEEP_0__

removeAllListeners() => Promise<void>

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

Since: 1.0.0

__CAPGO_KEEP_0__

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>

アプリ起動毎に毎回チェックしたい場合に便利な noNeedUpdate イベントリスナー

パラメータ	タイプ
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

戻り値: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘updateAvailable’, …)

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

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__
`eventName`	`’updateAvailable’`
`listenerFunc`	`(state: UpdateAvailableEvent) => void`

__CAPGO_KEEP_4__ Promise<PluginListenerHandle>

__CAPGO_KEEP_5__ 4.0.0

__CAPGO_KEEP_6__

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

__CAPGO_KEEP_9__

__CAPGO_KEEP_10__	__CAPGO_KEEP_11__
`eventName`	`’downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

addListener(‘majorAvailable’, …)

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

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

Param	Type
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

Returns: Promise<PluginListenerHandle>

Since: 2.3.0

addListener(‘updateFailed’, …)

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

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

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`eventName`	`’updateFailed’`
`listenerFunc`	`(state: UpdateFailedEvent) => void`

__CAPGO_KEEP_3__ Promise<PluginListenerHandle>

__CAPGO_KEEP_4__ 2.3.0

__CAPGO_KEEP_5__

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

__CAPGO_KEEP_8__

セクション「__CAPGO_KEEP_9__」	__CAPGO_KEEP_0__
`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>

App が利用可能になるまでの準備が整ったときに、App でアプリの準備完了イベントをリスンする

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

戻り値: Promise<PluginListenerHandle>

Since: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

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

戻り値: Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

戻り値 Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…)

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

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

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

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

インターフェイス

AppReadyResultのセクション

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

バンドル情報

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

更新URL

統計URL	統計URL
`url`	`string`

__CAPGO_KEEP_0__

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

ChannelUrl

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

DownloadOptions

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

プロパティ	型	説明	Default	__CAPGO_KEEP_1__
`url`	`string`	配布 ZIP ファイルの URL (例: dist.zip) をダウンロードします。 (任意の URL になります。例: Amazon S3、GitHub タグ、配布したい場所など)
`version`	`string`	The version code/name of this bundle/version
`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

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`id`	`string`

BundleListResult

__CAPGO_KEEP_0__	__CAPGO_KEEP_0__
`bundles`	`BundleInfo[]`

ListOptions

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

ResetOptions

Prop	Type
`toLastSuccessful`	`boolean`

CurrentBundleResult

Prop	Type
`bundle`	`BundleInfo`
`native`	`string`

__CAPGO_KEEP_0__

プロパティ	型
`delayConditions`	`DelayCondition[]`

DelayCondition

プロパティ	型	説明
`kind`	`DelayUntilNext`	setMultiDelayの遅延条件を設定
`value`	`string`

プロパティ	種類	説明	Since
`version`	`string`	__CAPGO_KEEP_0__	4.0.0
`checksum`	`string`		6
`major`	`boolean`
`message`	`string`
`sessionKey`	`string`
`error`	`string`
`old`	`string`
`url`	`string`
`manifest`	`ManifestEntry[]`		6.1

GetLatestOptions

プロパティ	種類	説明	デフォルト	Since
`channel`	`string`	最新バージョンを取得するためのチャンネル The channel must allow ‘self_assign’ for this to work	`undefined`	6.8.0

ChannelRes

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

SetChannelOptions

Prop	Type
`channel`	`string`
`triggerAutoUpdate`	`boolean`

チャンネル設定を解除するオプション

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

GetChannelRes

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

ListChannelsResult

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

チャンネル情報

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

Prop

BuiltinVersion	「BuiltinVersion」
`customId`	`string`

Prop

__CAPGO_KEEP_0__	種類
`version`	`string`

デバイスID

プロパティ	種類
`deviceId`	`string`

プラグインバージョン

プロパティ	種類
`version`	`string`

自動更新有効

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

__CAPGO_KEEP_0__

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

ダウンロードイベント

プロパティ	タイプ	説明	バージョン
`percent`	`number`	ダウンロードの現在の状態、0 から 100 まで	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

Prop	Type	説明	Since
`bundle`	`BundleInfo`	ダウンロードの進行状況（0から100）	4.0.0

UpdateAvailableEvent

Prop	Type	説明	現在
`bundle`	`BundleInfo`	0 から 100 までの間のダウンロードの現在状態。	4.0.0

DownloadCompleteEvent

Prop	Type	説明	新しいアップデートが利用可能になったときに発生します。
`bundle`	`BundleInfo`	MajorAvailableEvent	4.0.0

セクション「MajorAvailableEvent」

__CAPGO_KEEP_0__	種類	説明	Since
`version`	`string`	__CAPGO_KEEP_0__の新しいメジャーバンドルが利用可能になったときに発行されます。	4.0.0

UpdateFailedEvent

プロパティ	種類	説明	Since
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__の更新がインストールに失敗したときに発行されます。	4.0.0

DownloadFailedEvent

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

アプリケーション読み込み完了イベント

型	説明	バージョン	バージョン
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__	5.2.0
`status`	`string`

自動更新が利用可能です

__CAPGO_KEEP_0__	__CAPGO_KEEP_1__
`available`	`boolean`

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__
`enabled`	`boolean`

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__	種類
`enabled`	`boolean`

種類エイリアス

バンドルステータス

__CAPGO_KEEP_0__: バンドルが準備中です。 __CAPGO_KEEP_0__: 次のバンドルとして設定されます。 __CAPGO_KEEP_0__: バンドルがダウンロードされ、次のバンドルとして設定されます。 __CAPGO_KEEP_0__: ダウンロードに失敗しました。 遅延するまでの時間

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

遅延するまでの時間

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

関数と設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

コピー

次の…

set(…)

delete(…)

list(…)

reset(…)

current()

reload()

setMultiDelay(…)

キャンセル

Section titled “getLatest(…)”

setChannel(…)

セクション「unsetChannel(…)」

getChannel()

listChannels()

setCustomId(…)

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

addListener(‘noNeedUpdate’, …)

addListener(‘updateAvailable’, …)

__CAPGO_KEEP_6__

addListener(‘majorAvailable’, …)

addListener(‘updateFailed’, …)

__CAPGO_KEEP_5__

addListener(‘appReloaded’, …)を呼び出す

addListener(‘appReady’, …)を呼び出す

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

インターフェイス

AppReadyResultのセクション

バンドル情報

更新URL

__CAPGO_KEEP_0__

ChannelUrl

DownloadOptions

マニフェストエントリ

バンドルID

BundleListResult

ListOptions

ResetOptions

CurrentBundleResult

__CAPGO_KEEP_0__

DelayCondition

最新バージョン

GetLatestOptions

ChannelRes

SetChannelOptions

チャンネル設定を解除するオプション

GetChannelRes

ListChannelsResult

チャンネル情報

Prop

Prop

デバイスID

プラグインバージョン

自動更新有効

__CAPGO_KEEP_0__

ダウンロードイベント

NoNeedEvent

UpdateAvailableEvent

DownloadCompleteEvent

セクション「MajorAvailableEvent」

UpdateFailedEvent

DownloadFailedEvent

アプリケーション読み込み完了イベント

自動更新が利用可能です