Functionsと設定

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

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

「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 \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	Android、iOS、Electronで利用可能なAuto Updateの設定を指定します。trueは「atBackground」と同じです。falseは「off」と同じです。 - off: Auto Updateを無効化 - atBackground: アプリがバックグラウンドに移動するまで自動でチェックし、ダウンロードし、適用します。 - atInstall: フレッシュインストールまたはネイティブアプリの更新後にのみ適用し、他の場合はatBackgroundを使用します。 - onLaunch: 起動時に即座に適用し、起動チェック後にatBackgroundを使用します。 - always: Auto Updateが実行される度に即座に適用します。 - onlyDownload: 自動でチェックし、ダウンロードし、updateAvailableを発行し、次のバンドルを自動設定せずに終了します。	`”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で利用可能なアプリケーションの現在のバージョンを設定します。このバージョンは最初の更新要求に使用されます。設定されていない場合はネイティブのcodeからバージョンを取得します。	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	Android、iOS、Electronで利用可能な自動更新のオプションを使用するように推奨されています。 “atInstall”、 “onLaunch”、または “always” のいずれかを使用してください。このオプションは既存のアプリケーション向けにサポートされます。 - false: 直接更新を実行しない - atInstall: autoUpdate: “atInstall”と同じ - onLaunch: autoUpdate: “onLaunch”と同じ - always: autoUpdate: “always”と同じ - true: “always”と同じで、バックワード互換性のためにサポートされています。	`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`	Configure the CLI to use a local api for testing.	`undefined`	6.3.3
`localApiFiles`	`string`	Configure the CLI to use a local file api for testing.	`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`	デバッグ/テスト用にアップデートメニューを表示するためにシェイクジェスチャーを有効にします。	`false`	7.5.0

例

コピー 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
    }
  }
}

インターフェイス 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>

アプリケーションのアップデート用の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が付いたファイルが入ったりします。

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

次(…) Promise<BundleInfo>

Section titled “次(…)”

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

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

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

戻り値: Promise<BundleInfo>

set(…)

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

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

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

コピー

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

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

パラメータ	タイプ	説明
`options`	`BundleId`	A {@link} BundleId} 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 Apple App Store / Google Play Store から送信されたバンドル、または最後に正常に読み込まれたバンドルにリセットします。

パラメータ	型	説明
`options`	`ResetOptions`	関連する{@link ResetOptions.toLastSuccessful}, `true` reset to the default bundle and `false` will reset to the last successfully loaded bundle.

current()

current() => Promise<CurrentBundleResult>

現在のバンドルを取得します。なしの場合はデフォルトのバンドルを返します。 builtincurrentNativeはデバイスにインストールされている元のバンドルです。

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

キャンセルする {@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() __CAPGO_KEEP_0__ unsetChannel() __CAPGO_KEEP_1__
使用 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`

シnce: 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: If trueこのチャンネルは 自律割り当て可能なチャンネル. このチャンネルにデバイスを明示的に割り当てることができます。 setChannel().

Returns: Promise<ListChannelsResult>

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

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

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

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

戻り値 Promise<PluginListenerHandle>

バージョン 2.0.11

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

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

パラメーター

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

パラメーター

タイプ	addListener(‘majorAvailable’, …)
`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	説明
`options`	`SetShakeMenuOptions`	isShakeMenuEnabled()の有効/無効のboolean値を含む

Since: 7.5.0

isShakeMenuEnabled()関数を呼び出す

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

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

バンドルID

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

バンドルリスト結果

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

リストオプション

Prop	Type	Description	Default	Since
`raw`	`boolean`	Whether to return the raw bundle list or the manifest. If true, the list will attempt to read the internal database instead of files on disk.	`false`	6.14.0

ResetOptions

Prop	Type
`toLastSuccessful`	`boolean`

内部データベースを読み込むのではなく、ディスク上のファイルを読み込むようにリストを試みるかどうか

プロパティ	タイプ
`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

GetLatestOptions

プロパティ	型	概要	デフォルト	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

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

ListChannelsResult

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

ChannelInfo

Prop	種類	説明	Since
`id`	`number`	数字チャンネルID	7.5.0
`name`	`string`	チャンネル名	7.5.0
`public`	`boolean`	このチャンネルがデフォルト/フォールバックチャンネルである場合にtrueを指定します。デバイスはパブリックチャンネンに自ら割り当てることはできません。デバイスがチャンネルオーバーライドを削除した場合 (削除方法は)、自動的にマッチングするパブリックチャンネルからアップデートを受け取るようになります。 `unsetChannel()`このチャンネルがデフォルト/フォールバックチャンネルである場合にtrueを指定します。デバイスはパブリックチャンネンに自ら割り当てることはできません。デバイスがチャンネルオーバーライドを削除した場合 (削除方法は)、自動的にマッチングするパブリックチャンネルからアップデートを受け取るようになります。	7.5.0
`allow_self_set`	`boolean`	このチャンネルがデフォルト/フォールバックチャンネルである場合にtrueを指定します。デバイスはパブリックチャンネンに自ら割り当てることはできません。デバイスがチャンネルオーバーライドを削除した場合 (削除方法は)、自動的にマッチングするパブリックチャンネルからアップデートを受け取るようになります。 `setChannel()`チャンネルコマンドはチャンネル	7.5.0

数字 nameSetCustomIdOptions id.

SetCustomIdOptions

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

「BuiltinVersion」を設定する

型	デバイスID
`version`	`string`

プロパティ

プラグインバージョン	「DeviceId」を設定する
`deviceId`	`string`

「PluginVersion」を設定する

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

自動更新有効

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

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

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

プラグインバージョン

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

不要イベント

型	説明	バージョン	ダウンロードイベントの現在の状態、0から100まで。
`bundle`	`BundleInfo`	ダウンロードの進行状況、0から100まで。	4.0.0

UpdateAvailableEvent

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

DownloadCompleteEvent

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

MajorAvailableEvent

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

UpdateFailedEvent

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

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

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

AppReadyEvent

Prop	Type	Description	Since
`bundle`	`BundleInfo`	アプリが使用可能になったときに発行される。	5.2.0
`status`	`string`

AutoUpdateAvailable

Prop	Type
`available`	`boolean`

SetShakeMenuOptions

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

ShakeMenuEnabled

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

型別の別名

BundleStatus

pending: バンドルはまだ準備中です セット 次のバンドルとして設定します。 ダウンロード中: バンドルがダウンロード中です。 成功: バンドルがダウンロードされ、使用できるようになりました。

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

セット

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

エラー: バンドルをダウンロードできませんでした。

セクション: “次のバンドルまで待機” 機能と設定から続けて to plan dashboard and API operations, connect it with Capgoを使用している場合、ダッシュボードとcapgoの操作を計画するには、機能と設定を使用します。capgoとcapacitor-updaterを接続してください。 Capacitorのネイティブ機能のために@capgo/capacitor-updaterを使用します。 APIの概要 APIの実装詳細のためにAPIの概要を参照してください。導入 __CAPGO_KEEP_0__の実装詳細のために導入を参照してください。 APIのキー APIの実装詳細のためにAPIのキーを参照してください。デバイス __CAPGO_KEEP_0__の実装詳細のためにデバイスを参照してください。

Functionsと設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

Section titled “次(…)”

set(…)

コピー

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()関数を呼び出す

インターフェイス

AppReadyResult

BundleInfo

UpdateUrl

StatsUrl

ChannelUrl

ダウンロードオプション

マニフェストエントリ

バンドルID

バンドルリスト結果

リストオプション

ResetOptions

内部データベースを読み込むのではなく、ディスク上のファイルを読み込むようにリストを試みるかどうか

マルチ遅延条件

遅延条件

最新バージョン

GetLatestOptions

ChannelRes

SetChannelOptions

SetChannelOptions

GetChannelRes

ListChannelsResult

ChannelInfo

SetCustomIdOptions

「BuiltinVersion」を設定する

プロパティ

「PluginVersion」を設定する

自動更新有効

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

プラグインバージョン

不要イベント

UpdateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

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

AppReadyEvent

AutoUpdateAvailable