関数と設定

このプラグインのインストール手順と全マークダウンガイドを含むセットアップ用の質問をコピーできます。

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

「Github」を参照してください。詳細情報については、 CapacitorUpdater は次のオプションで構成できます:

Readme

Prop	Type	Description	Default	Since
`appReadyTimeout`	`number`	Android、iOS、Electronで使用可能な場合、nativeプラグインがアップデートを‘失敗’と考えるまで待つミリ秒数を設定します。	`10000 // (10 seconds)`
`responseTimeout`	`number`	Android、iOS、Electronで使用可能な場合、nativeプラグインがAPIタイムアウトを考えるまで待つミリ秒数を設定します。	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	Android、iOS、Electronで使用可能な場合、プラグインが失敗したバンドルを自動的に削除するかどうかを設定します。	`true`
`autoDeletePrevious`	`boolean`	Android、iOS、Electronで使用可能な場合、プラグインが成功したアップデート後に前のバンドルを自動的に削除するかどうかを設定します。	`true`
`autoUpdate`	`boolean`	Android、iOS、Electronで使用可能な場合、プラグインがAuto Updateを使用するかどうかを設定します。	`true`
`resetWhenUpdate`	`boolean`	Android、iOS、Electronで使用可能な場合、デバイスにインストールされた新しいnativeアプリケーションバンドルの場合、前のダウンロードしたバンドルを自動的に削除します。	`true`
`updateUrl`	`string`	Android、iOS、Electronで使用可能な場合、更新チェックが送信されるURL/エンドポイントを設定します。	`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: アプリがインストールされたときにのみ直接アップデートを実行します。ストアからアップデートされた場合、またはアプリが終了した場合に動作します。- onLaunch: アプリがインストールされたとき、またはストアからアップデートされたとき、またはアプリが終了したときにのみ直接アップデートを実行します。- always: 直接アップデートを実行します（アプリがインストールされたとき、ストアからアップデートされたとき、またはアプリが終了したときも含みます）。- 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`	CLI をローカルapi で使用するように設定します。	`undefined`	6.3.3
`localApiFiles`	`string`	CLI をローカルファイルapi で使用するように設定します。	`undefined`	6.3.3
`allowModifyUrl`	`boolean`	更新URL、統計URL、チャンネルURLをJavaScript側から動的に変更することを許可します。	`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": 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>

現在のバンドルが正常に動作していることを、Capacitor アップデートャーに通知します (このメソッドを各アプリ起動時に呼び出さない場合はロールバックが発生します)。デフォルトでは、アプリ起動後最初の10秒以内にこのメソッドを呼び出してください。そうしないとロールバックが発生します。この挙動を変更するには、{@link appReadyTimeout} を参照してください。

戻り値 Promise<AppReadyResult>

setUpdateUrl(…)

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

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

パラメーター	タイプ	説明
`options`	`UpdateUrl`	__CAPGO_KEEP_0__には、更新を確認するために使用するURLが含まれます。

Since: 5.4.0

setStatsUrl(…)

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

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

パラメーター	タイプ	説明
`options`	`StatsUrl`	__CAPGO_KEEP_0__には、統計データを送信するために使用する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ファイルで、ファイルが内部に含まれているか、または一意のIDが付いたファイルが含まれているか

パラメーター	タイプ	説明
`options`	`DownloadOptions`	ダウンロードする新しいバンドルzipのための{@link DownloadOptions}

戻り値: Promise<BundleInfo>

次の…

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

再起時に使用する次のバンドルを設定します。

Param	Type	説明
`options`	`BundleId`	再起時に使用する次のバンドルを設定するIDを含みます。 {@link BundleInfo.id}

戻り値: Promise<BundleInfo>

set(…)

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

現在のバンドルを設定し、すぐにアプリを再起します。

Param	種類	説明
`options`	`BundleId`	A {@link BundleId}オブジェクトが、新しいbundle idを設定する現在のbundle idとして設定します。

delete(…)

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

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

パラメーター	種類	説明
`options`	`BundleId`	A {@link {@link BundleId} object containing the ID of a bundle to delete (note, this is the bundle id, NOT the version name)list(…)

Section titled “list(…)

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

Param

Type	説明	The {@link ListOptions}
`options`	`ListOptions`	list(…) list(…)} for listing bundles

Returns: 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` __CAPGO_KEEP_0__をビルトインのバンドルにリセットします。 `false` __CAPGO_KEEP_0__は最後に正常に読み込まれたバンドルにリセットされます。

current()

current() => Promise<CurrentBundleResult>

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

Returns: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

__CAPGO_KEEP_0__を表示を再読み込みします

setMultiDelay(…)

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

Pluginが更新を遅延させるために使用する条件の配列を設定します。すべての条件が満たされた後、通常の更新プロセスが再び実行され、バックグラウンド化またはアプリを終了した後も更新がインストールされるようになります。 "kind"の値はISO8601形式の日付文字列でなければなりません。 "kind"の値は、ミリ秒単位の数値でなければなりません。 "kind"の値はバージョン番号でなければなりません。 "kind"の値は使用されません。この関数は、オプション「kill」がトリガーを発生させるように動作するが、最初のkill後に次のバックグラウンドでトリガーを発生させないように他のオプションと同じように動作するように修正される予定です。 ParamType date DelayCondition background DelayCondition nativeVersion DelayCondition kill DelayCondition

DelayCondition	DelayCondition	説明
`options`	`MultiDelayConditions`	キャンセル遅延条件を設定するための{@link MultiDelayConditions}条件の配列

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

キャンセル遅延条件をキャンセルして、更新を即時処理します。 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 この機能が動作するには有効にする必要があります。

重要な注意事項:

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

パラメータ	型	説明
`options`	`SetChannelOptions`	{@link を参照してください SetChannelOptions} のチャネルを設定します

戻り値: Promise<ChannelRes>

Since: 4.7.0

unsetChannel(…)

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

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

これは、以下のシナリオで便利です。

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

パラメーター	型
`options`	`UnsetChannelOptions`

シナリオ 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

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

Returns: Promise<GetChannelRes>

Since: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

publicIf trueこのチャンネルは デフォルトチャンネルです。自身のチャンネル割り当てを setChannel()に変更することはできません。 unsetChannel()__CAPGO_KEEP_0__
allow_self_set__CAPGO_KEEP_1__ trueこのデバイスは、このパブリックチャンネルから自動的に更新を受け取ります。 __CAPGO_KEEP_2__このチャンネルは、自分で割り当てることができます。 setChannel().

__CAPGO_KEEP_3__ Promise<ListChannelsResult>

Returns: 7.5.0

__CAPGO_KEEP_4__

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

「setCustomId(…)」のセクション

コピー	タイプ	説明
`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>

送信されるデバイスのユニークIDを取得するために送信されるネイティブ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

addListener(‘updateAvailable’, …)

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

アプリ起動時に毎回チェックしたい場合に利用できる更新イベントをリスンする

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

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

addListener(‘downloadComplete’, …)

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

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

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

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

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

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

アプリでメジャーアップデートイベントをリスンし、メジャーアップデートが自動アップデートブロッキングでブロックされている場合に通知します

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

戻り値: Promise<PluginListenerHandle>

バージョン: 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によって無効化されていない場合)

戻り値: 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__が有効かどうかを示すブール値を含む、シェイクメニューを有効または無効にする

Since: 7.5.0

__CAPGO_KEEP_0__はシェイクメニューが有効かどうかを返す

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

シェイクメニューの現在の状態を取得する

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

プロパティ

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

オプションのリセット

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

現在のバンドル結果

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

プロパティ	種類	説明
`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

GetLatestオプション

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

__CAPGO_KEEP_0__

__CAPGO_KEEP_1__	__CAPGO_KEEP_2__	__CAPGO_KEEP_3__	__CAPGO_KEEP_4__
`status`	`string`	__CAPGO_KEEP_5__	4.7.0
`error`	`string`
`message`	`string`

チャンネルの現在の状態

__CAPGO_KEEP_7__	種類
`channel`	`string`
`triggerAutoUpdate`	`boolean`

__CAPGO_KEEP_0__

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

GetChannelRes

プロパティ	種類	説明	バージョン
`channel`	`string`	現在の状態：get channel	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

チャンネルリスト結果

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

チャンネル情報

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

Prop

BuiltinVersion	__CAPGO_KEEP_1__
`customId`	`string`

__CAPGO_KEEP_2__

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

デバイスID

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

プラグインバージョン

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

自動更新有効

Prop	Type
`enabled`	`boolean`

PluginListenerHandle

Prop	Type
`remove`	`() => Promise<void>`

DownloadEvent

Prop	Type	説明	現在
`percent`	`number`	__CAPGO_KEEP_0__	4.0.0
`bundle`	`BundleInfo`

NoNeedEvent

Prop	Type	説明	現在
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__	4.0.0

UpdateAvailableEvent

Prop	種類	説明	Since
`bundle`	`BundleInfo`	ダウンロードの進行状況、0から100まで。	4.0.0

DownloadCompleteEvent

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

MajorAvailableEvent

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

UpdateFailedEvent

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

DownloadFailedEvent

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

AppReadyEvent

プロパティ	型	概要	Since
`bundle`	`BundleInfo`	__CAPGO_KEEP_0__が使用できるようになったときに発行されます。	5.2.0
`status`	`string`

自動更新が利用可能

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

シェイクメニューの設定

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

シェイクメニューが有効

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

型のエイリアス

バンドルステータス

pending: バンドルがダウンロード待ちです。 SET 次のバンドルとしてダウンロード中です。 SET ダウンロードが完了し、次のバンドルとして使用できる状態です。

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

__CAPGO_KEEP_0__

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

関数と設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

次の…

set(…)

delete(…)

Section titled “list(…)

reset(…)

current()

reload()

setMultiDelay(…)

cancelDelay()

getLatest(…)

setChannel(…)

unsetChannel(…)

getChannel()

listChannels()

__CAPGO_KEEP_4__

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

removeAllListeners()

addListener('download', …)

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

addListener(‘updateAvailable’, …)

addListener(‘downloadComplete’, …)

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

リスナーを追加（‘updateFailed’，…）

リスナーを追加（‘downloadFailed’，…）

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

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

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

__CAPGO_KEEP_0__はシェイクメニューが有効かどうかを返す

インターフェイス

AppReadyResult

BundleInfo

UpdateUrl

StatsUrl

ChannelUrl

DownloadOptions

マニフェストエントリ

BundleId

BundleListResultのセクション

プロパティ

オプションのリセット

現在のバンドル結果

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

最新バージョン

GetLatestオプション

__CAPGO_KEEP_0__

チャンネルの現在の状態

__CAPGO_KEEP_0__

GetChannelRes

チャンネルリスト結果

チャンネル情報

Prop

__CAPGO_KEEP_2__

デバイスID

プラグインバージョン

自動更新有効

PluginListenerHandle

DownloadEvent

NoNeedEvent

UpdateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

DownloadFailedEvent

AppReadyEvent

自動更新が利用可能

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