Functionsと設定

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

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

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

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

プロパティ	型	説明	デフォルト	シーケンス
`appReadyTimeout`	`number`	Android、iOS、Electronで利用可能な場合、nativeプラグインがアップデートを‘失敗’と考えるまでのミリ秒数を設定します。	`10000 // (10 seconds)`
`responseTimeout`	`number`	Android、iOS、Electronで利用可能な場合、APIタイムアウトを考慮するためにnativeプラグインが待つミリ秒数を設定します。	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	Android、iOS、Electronで利用可能な場合、失敗したバンドルを自動的に削除するかどうかを設定します。	`true`
`autoDeletePrevious`	`boolean`	Android、iOS、Electronで利用可能な場合、成功したアップデート後に前のバンドルを自動的に削除するかどうかを設定します。	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	アップデートサーバーを介して自動アップデートを有効にする方法を設定します。trueは「atBackground」と同じであり、falseは「off」と同じです。 - off: 自動アップデートを無効 - atBackground: アプリがバックグラウンドに移動したときに自動でダウンロードして適用 - atInstall: フレッシュインストールまたはネイティブアプリのアップデートの場合のみ即座に適用、他の場合はatBackground - onLaunch: 起動時に即座に適用、起動チェック後はatBackground - always: 自動アップデートが実行されるたびに即座に適用 - onlyDownload: 自動でダウンロードしてアップデート用のバンドルを設定せずにupdateAvailableを発行します。Android、iOS、Electronで利用可能です。	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	Android、iOS、Electronで利用可能な自動で以前ダウンロードしたバンドルを削除する機能です。	`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で利用可能なエンドツーエンドライブアップデートの暗号化のための公開鍵を設定します。バージョン2。	`undefined`	6.2.0
`version`	`string`	Android、iOS、Electronで利用可能なアプリの現在のバージョンを設定します。このバージョンは、最初の更新要求で使用されます。設定しない場合は、プラグインはnative codeからバージョンを取得します。	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	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`	ローカルapiを使用するようにCLIを設定します。	`undefined`	6.3.3
`localApiFiles`	`string`	ローカルファイルapiを使用するようにCLIを設定します。	`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`	デバッグ/テスト用にアップデートメニューを表示するために 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>

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}

戻り値: 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`	statisticを送信するために使用するURLを含みます。

Since: 5.4.0

setChannelUrl(…)

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

アプリのchannelUrlを設定します。この値はchannelを設定するために使用されます。

Param	Type	説明
`options`	`ChannelUrl`	channelを設定するために使用するURLを含みます。

Since: 5.4.0

download(…)

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

指定されたURLから新しいバンドルをダウンロードします。zipファイルで、内部にファイルが入ったり、ユニークIDが付いたファイルが入ったりします。

パラメーター	タイプ	ダウンロードする新しいバンドルzipファイルのオプションです。
`options`	`DownloadOptions`	戻り値: 次(…)次の(…)

protectedTokens Promise<BundleInfo>

items

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

アプリが再起動されたときに使用する次のバンドルを設定します。

パラメーター	タイプ	説明
`options`	`BundleId`	次のアプリ起動時に使用するバンドルのIDを含みます。{@link} BundleInfo.id}

戻り値: Promise<BundleInfo>

set(…)

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

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

パラメータ	タイプ	説明
`options`	`BundleId`	A {@link} BundleId} object containing the new bundle id to set as current.

delete(…)

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

Deletes the specified bundle from the native app storage. Use with {@link list} to get the stored Bundle IDs.

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

list(…)

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

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

Param	Type	説明
`options`	`ListOptions`	The {@link} リストオプション} でバンドルの一覧を表示

戻り値: Promise<BundleListResult>

reset(…)

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

アプリを builtin アプリストア/Google Playストアから送信されたバンドルまたは最後に正常に読み込まれたバンドルにリセットします。

パラメータ	型	説明
`options`	`ResetOptions`	Containing {@link ResetOptions.toLastSuccessful}, `true` resets to the builtin bundle and `false` will reset to the last successfully loaded bundle.

current()

current() => Promise<CurrentBundleResult>

Get the current bundle, if none are set it returns builtincurrentNative is the original bundle installed on the device

Returns: Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

表示を再読み込み

setMultiDelay(…)

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

条件を指定してアップデートを遅延させる遅延条件遅延条件の配列を指定します。この配列内の条件がすべて満たされたら、通常のアップデートプロセスが再び実行され、バックグラウンド化またはアプリを終了してもアップデートがインストールされるようになります。 date kindの値はISO8601形式の日付文字列でなければなりません。 background kindの値はミリ秒単位の数値でなければなりません。 nativeVersion kindの値はバージョン番号でなければなりません。 kill kindの値は使用されません。この関数はkillオプションを指定すると、最初のkill後にアップデートが実行されず、次のバックグラウンド化後にアップデートが実行されるようになります。この不一致な動作は、将来のメジャーリリースで修正されます。

パラメータ	種類	説明
`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>

Since： 4.0.0

setChannel(…)

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

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

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

重要な注意事項:

このメソッドを使用して、起動時にチャンネルを設定しないでください。代わりに__CAPGO_KEEP_0__の設定に defaultChannel in your Capacitor config instead.
パブリックチャンネルは自分で割り当てることができません。
チャンネルが を呼び出すとエラーが返されます。パブリックチャンネルを使用するには、 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.
使用 listChannels() を使用して、利用可能なチャンネルを検出し、自律割り当てを許可するかどうかを確認します。

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

戻り値: Promise<ChannelRes>

バージョン: 4.7.0

unsetChannel(…)

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

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

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

これは、次のような場合に便利です:

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

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

シンス 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

Since: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

publicこの場合、 trueデフォルトのチャンネル protectedTokens自動割り当てを自分で行うことはできません。 setChannel()代わりに、チャンネル割り当てを削除することで、デバイスは自動的にこのパブリックチャンネルからアップデートを受け取ることになります。 unsetChannel()このパブリックチャンネルからアップデートを受け取る場合、次の条件が満たされている場合にのみ、デバイスは自動的にこのパブリックチャンネルからアップデートを受け取ることになります。
allow_self_setこのチャンネルは true自分で割り当てが可能なチャンネル このチャンネルにデバイスを明示的に割り当てることができます。戻り値: setChannel().

Since: Promise<ListChannelsResult>

setCustomId(…) 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>

Get the native Capacitor Updater plugin version (sent to auto update server)

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

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

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

戻り値 Promise<PluginListenerHandle>

バージョン 2.0.11

addListener(‘noNeedUpdate’, …)のセクション

addListener(eventName: 'noNeedUpdate', listenerFunc: (state: NoNeedEvent) => void) => Promise<PluginListenerHandle>

パラメーター

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

戻り値: Promise<PluginListenerHandle>

バージョン: 4.0.0

addListener(‘majorAvailable’, …)のセクション

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

パラメーター

タイプ	__CAPGO_KEEP_0__
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

戻り値: Promise<PluginListenerHandle>

Since: 2.3.0

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

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

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

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

戻り値: Promise<PluginListenerHandle>

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

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

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

アプリ内でリロードイベントをリスンし、リロードが発生したときに知らせる

パラメーター	タイプ
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

戻り値: Promise<PluginListenerHandle>

Since: 4.3.0

addListener(‘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>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

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

戻り値: Promise<BundleInfo | null>

Since: 6.8.0

setShakeMenu(…)

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

デバッグ/テスト用にシェイクメニューの有効/無効を切り替えます。

Param	Type	Description
`options`	`SetShakeMenuOptions`	有効/無効のboolean値を含み、シェイクメニューの有効/無効を切り替えます。

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

インターフェイス

アプリケーション準備結果

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

バンドル情報

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

更新URL

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

StatsUrl

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

ChannelUrl

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

ダウンロードオプション

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

プロパティ	タイプ	説明	デフォルト	バージョン
`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`

BundleId

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

BundleListResult

プロパティ	型
`bundles`	`BundleInfo[]`

ListOptions

Prop	Type	Description	Default	Since
`raw`	`boolean`	BundleリストをRAWリストかマニフェストリストとして返すかどうかを指定します。trueの場合、リストは内部データベースを読み込むのではなく、ディスク上のファイルを読み込もうとします。	`false`	6.14.0

ResetOptions

Type	CurrentBundleResult
`toLastSuccessful`	`boolean`

__CAPGO_KEEP_0__

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

複数の遅延条件

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

遅延条件

プロパティ	型	説明
`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オプション

プロパティ	型	概要	デフォルト	Since
`channel`	`string`	最新バージョンの取得に使用するチャンネルを指定します。チャンネルは 'self_assign' を許可している必要があります。	`undefined`	6.8.0

ChannelRes

プロパティ	タイプ	概要	Since
`status`	`string`	設定済みのチャンネルの現在の状態	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

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

SetChannelOptions

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

GetChannelRes

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

ListChannelsResult

Prop	Type	説明	Since
`channels`	`ChannelInfo[]`	利用可能なチャンネルのリスト	7.5.0

ChannelInfo

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

チャンネルコマンドはチャンネル nameを使用します。数字 id.

は使用しません。

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

バージョン

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

デバイスID

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

プラグインバージョン

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

自動更新有効

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

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

型	ダウンロードイベント
`remove`	`() => Promise<void>`

__CAPGO_KEEP_0__

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

不要イベント

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

UpdateAvailableEvent

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

DownloadCompleteEvent

プロパティ	型	概要	Since
`bundle`	`BundleInfo`	新バージョンが利用可能になったときに発生します。	4.0.0

MajorAvailableEvent

Prop	Type	概要	Since
`version`	`string`	新バージョンのメジャーバンドルが利用可能になったときに発生します。	4.0.0

UpdateFailedEvent

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

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

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

AppReadyEvent

Prop	Type	Description	Since
`bundle`	`BundleInfo`	AppReadyEventが利用可能になりました。	5.2.0
`status`	`string`

AutoUpdateAvailable

Prop	Type
`available`	`boolean`

SetShakeMenuOptions

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

ShakeMenuEnabled

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

型別の別名

BundleStatus

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

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

セット

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

エラー: バンドルがダウンロードに失敗しました。

DelayUntilNext Functions and settings から続ける Functions and settings を使用してダッシュボードと API の操作を計画している場合、API を __CAPGO_KEEP_1__-updater に接続してください。 Using @capgo/capacitor-updater Capgoのネイティブ機能のために@capgo/capacitor-updaterを使用します。 APIの概要 Capgoの実装詳細のためにAPIの概要を参照してください。導入実装詳細のために導入を参照してください。 APIのキー実装詳細のためにAPIのキーを参照してください、デバイス実装詳細のためにデバイスを参照してください。

Functionsと設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

items

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

インターフェイス

アプリケーション準備結果

バンドル情報

更新URL

StatsUrl

ChannelUrl

ダウンロードオプション

マニフェストエントリ

BundleId

BundleListResult

ListOptions

ResetOptions

__CAPGO_KEEP_0__

複数の遅延条件

遅延条件

最新バージョン

GetLatestオプション

ChannelRes

SetChannelOptions

SetChannelOptions

GetChannelRes

ListChannelsResult

ChannelInfo

は使用しません。

バージョン

デバイスID

プラグインバージョン

自動更新有効

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

__CAPGO_KEEP_0__

不要イベント

UpdateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

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

AppReadyEvent

AutoUpdateAvailable