Functions と設定

インストール手順とフルマークダウンガイドのセットアップの質問をコピーしてください。

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

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

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

プロパティ	型	説明	デフォルト値	__CAPGO_KEEP_0__秒以内に更新が失敗と判断されるように設定します。Android、iOS、Electronで利用可能です。
`appReadyTimeout`	`number`	__CAPGO_KEEP_0__秒以内にタイムアウトと判断されるように設定します。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`	プラグインがAuto Updateを使用する方法を、更新サーバー経由で設定します。trueは「atBackground」と同じです。falseは「off」と同じです。 - off: Auto Updateを無効化 - atBackground: アプリがバックグラウンドに移動するまで自動でチェックしダウンロードし、適用します - atInstall: フレッシュインストールまたはネイティブアプリの更新後のみ、即座に適用し、他の場合はatBackgroundを使用します - onLaunch: 起動時に即座に適用し、起動チェック後はatBackgroundを使用します - always: Auto Updateが実行される度に即座に適用します - onlyDownload: 自動でチェックしダウンロードし、updateAvailableを発行し、次のバンドルを自動設定せずに終了します。Android、iOS、Electronで利用可能です。	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	新しいネイティブアプリバンドルがデバイスにインストールされたときに、自動的に前のダウンロードしたバンドルを削除します。Android、iOS、Electronで利用可能です。	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	更新チェックの送信先のURL/エンドポイントを設定します。Android、iOS、Electronで利用可能です。	`true`
`updateUrl`	`string`	__CAPGO_KEEP_0__	`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’`	廃止。代わりに “atInstall”、 “onLaunch”、または “always” のオートアップデート文字列モードを使用してください。このオプションは既存のアプリ向けにサポートされます。- false: 直接アップデートを行わない- atInstall: autoUpdate: “atInstall”と同じ- onLaunch: autoUpdate: “onLaunch”と同じ- always: autoUpdate: “always”と同じ- true: “always”と同じ（バックワード互換性のために）。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

例

内 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`	__CAPGO_KEEP_0__を使用するURLを含みます。

Since: 5.4.0

setChannelUrl(…)

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

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

Param	Type	説明
`options`	`ChannelUrl`	__CAPGO_KEEP_0__を使用するURLを含みます。

Since: 5.4.0

download(…)

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

指定されたURLから新しいバンドルをダウンロードします。zipファイルで、ファイルが内部に含まれているか、または一意のIDが付いたファイルが内部に含まれているか

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

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

delete(…)

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

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

パラメータ	型	説明
`options`	`BundleId`	IDを指定したバンドルを削除するための{@link}オブジェクト BundleIdバンドルID

list(…)

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

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

Param	Type	説明
`options`	`ListOptions`	The {@link} リストオプション__CAPGO_KEEP_0__

バンドルをリストするための} Promise<BundleListResult>

戻り値:

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>

再読み込み

__CAPGO_KEEP_0__

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

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

__CAPGO_KEEP_0__	種類	説明
`options`	`MultiDelayConditions`	条件を設定するために{@link MultiDelayConditions}の配列を含む

Since: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

キャンセル Cancels a {@linkDelayCondition

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>

__CAPGO_KEEP_0__ allow_device_self_set __CAPGO_KEEP_0__

setChannel() validates the channel with the backend, then stores the selected channel locally on the device. It does not create or update a backend Device Override, so the device will not appear as overridden in the Capgo dashboard. Only assignments created from the dashboard or the Public API are shown in the Device Override UI.

__CAPGO_KEEP_0__

このデバイスのローカルチャンネルをプラグインが管理するように設定します。チャンネルは defaultChannel in your Capacitor config instead.
バックエンドとチャンネルを検証し、選択したチャンネルをデバイス上にローカルに保存します。バックエンドのデバイスオーバーライドを作成または更新しないため、デバイスは__CAPGO_KEEP_0__ダッシュボードでオーバーライドとして表示されません。ダッシュボードまたはPublic __CAPGO_KEEP_1__からのみ作成された割り当てのみ、デバイスオーバーライドUIで表示されます。
重要な注意事項: このメソッドを起動時に使用しないでください。__CAPGO_KEEP_0__の設定に代わって publicを使用してください。 setChannel() このメソッドは、ユーザーがアプリを使用し、例えばベータプログラムに参加した後、使用するように設計されています。 unsetChannel() パブリックチャンネルは自社で割り当てることはできません。
使用して、利用可能なチャンネルを検出し、自ら割り当てることを許可するかどうかを確認します。 listChannels() パラメーター

型	説明	{@link SetChannelOptions} を設定するチャンネルを指定します。
`options`	`SetChannelOptions`	戻り値: バージョン:unsetChannel(…)

セクション「unsetChannel(…)」 Promise<ChannelRes>

タイトル: unsetChannel(…) 4.7.0

unsetChannel(…) の説明

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

このデバイスのために、プラグインが管理するローカルチャネルを解除します。このメソッドは、ローカルに保存されているチャネルを削除するのみであり、ダッシュボードまたはパブリック __CAPGO_KEEP_0__ デバイスオーバーライドのレコードを削除することはありません。 setChannel()このメソッドを呼び出した後、通常のチャネル優先順位が適用されます: 既存のダッシュボードまたはパブリック API デバイスオーバーライドが優先される場合、デバイスはプラットフォーム、デバイスタイプ、ビルドタイプに基づいてマッチングするパブリック/デフォルトチャネルにフォールバックすることができます。

After calling this method, normal channel precedence applies: an existing Dashboard or Public API Device Override still wins; otherwise the device can fall back to the matching public/default channel for its conditions (platform, device type, build type).

デバイスをデフォルトのアップデートトラックに戻したい場合

パブリックチャネルを使用したい場合 (パブリックチャネルは自社で割り当てることはできないため)
パラメータ setChannel())

タイプ	Since:
`options`	`UnsetChannelOptions`

getChannel() 4.7.0

セクション “getChannel()”

getChannel() => Promise<GetChannelRes>

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

戻り値: Promise<GetChannelRes>

シンス: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

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

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

public: その場合、 trueデフォルトのチャンネル デフォルトのチャンネル. 自分で割り当てることはできません。 setChannel(). その代わりに、チャンネル割り当てを削除することで、デバイスは自動的にこのパブリックチャンネルから更新を受け取るようになります。 unsetChannel(): If
allow_self_set、このチャンネルは true自律割り当て可能なチャンネル です。デバイスをこのチャンネルに明示的に割り当てることができます。Returns: setChannel().

Since: Promise<ListChannelsResult>

setCustomId(…) 7.5.0

タイトル： "setCustomId(…)"

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

このデバイスにカスタムIDを設定

パラメーター	タイプ	説明
`options`	`SetCustomIdOptions`	は {@link SetCustomIdOptions} のカスタムIDを設定します

バージョン 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

ネイティブアプリのバージョンを取得、または設定されたconfigで指定されている場合のバuiltinバージョンを取得します

戻り値: Promise<BuiltinVersion>

以下の情報は、Capgoの開発者が提供する情報です。 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

デバイスのユニークIDを取得します。このIDは、自動更新サーバーに送信されます。

戻り値: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

ネイティブのCapacitorアップデートプラグインのバージョンを取得します。このバージョンは、自動更新サーバーに送信されます。

戻り値: Promise<PluginVersion>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

自動更新設定の状態を取得します。

戻り値： Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

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

バージョン： 1.0.0

addListener('download', …)

addListener(eventName: 'download', listenerFunc: (state: DownloadEvent) => void) => Promise<PluginListenerHandle>

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

パラメーター	タイプ
`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>

Since: 4.0.0

addListener('downloadComplete', ...) を呼び出す

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

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__	__CAPGO_KEEP_3__
`eventName`	`’downloadComplete’`
`listenerFunc`	`(state: DownloadCompleteEvent) => void`

__CAPGO_KEEP_4__ Promise<PluginListenerHandle>

__CAPGO_KEEP_5__ 4.0.0

__CAPGO_KEEP_6__

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

__CAPGO_KEEP_9__

__CAPGO_KEEP_10__	__CAPGO_KEEP_11__
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

戻り値: Promise<PluginListenerHandle>

期間: 2.3.0

updateFailed イベントリスナーを追加（…）

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

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

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

戻り値: Promise<PluginListenerHandle>

期間: 2.3.0

downloadFailed イベントリスナーを追加（…）

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

アプリのダウンロード失敗イベントをリスンし、バンドルダウンロードが失敗したときに知らせる

Param	Type
`eventName`	`’downloadFailed’`
`listenerFunc`	`(state: DownloadFailedEvent) => void`

Returns: Promise<PluginListenerHandle>

Since: 4.0.0

addListener('appReloaded', …)

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

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

Param	Type
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

戻り値: Promise<PluginListenerHandle>

期間: 4.3.0

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

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__ Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

__CAPGO_KEEP_1__

__CAPGO_KEEP_2__ 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コマンドでバンドルを暗号化した場合、受信する必要があります。暗号化した結果はコマンドの結果になります。

Prop	Type	説明	デフォルト	Since
`url`	`string`	GitHub/nameバンドルのバージョン
`version`	`string`	codeバンドルのURLのzipファイル(例: dist.zip)をダウンロードするためのURL(任意のURLが可能です。例: Amazon S3、codeタグ、他のどこにでもバンドルをホストしている場所)。
`sessionKey`	`string`	__CAPGO_KEEP_0__バンドルのバージョン	`undefined`	4.0.0
`checksum`	`string`	__CAPGO_KEEP_0__バンドルをアップデートするためのセッションキー	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	__CAPGO_KEEP_0__バンドルをアップデートするためのチェックサム(sha256で暗号化してください)	`undefined`	6.1.0

Delta (manifest) マルチファイルダウンロードのためのマニフェスト

プロパティ	型
`file_name`	`string \| null`
`file_hash`	`string \| null`
`download_url`	`string \| null`

BundleId

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

BundleListResult

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

ListOptions

プロパティ	型	説明	デフォルト	Since
`raw`	`boolean`	raw bundleリストを取得するか、manifestを取得するかを選択します。trueの場合、リストは内部データベースを読み込むのではなく、ディスク上のファイルを読み込もうとします。	`false`	6.14.0

ResetOptionsセクション

型	CurrentBundleResult
`toLastSuccessful`	`boolean`

__CAPGO_KEEP_0__

プロパティ	タイプ
`bundle`	`BundleInfo`
`native`	`string`

MultiDelayConditionsのセクション

タイプ	DelayCondition
`delayConditions`	`DelayCondition[]`

プロパティ

説明	DelayCondition	MultiDelayConditions
`kind`	`DelayUntilNext`	遅延条件をセットアップする
`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	種類	説明	__CAPGO_KEEP_0__
`id`	`number`	__CAPGO_KEEP_0__	7.5.0
`name`	`string`	__CAPGO_KEEP_0__	7.5.0
`public`	`boolean`	__CAPGO_KEEP_0__ `unsetChannel()`__CAPGO_KEEP_0__	7.5.0
`allow_self_set`	`boolean`	__CAPGO_KEEP_0__ `setChannel()`__CAPGO_KEEP_0__	7.5.0

__CAPGO_KEEP_0__ name__CAPGO_KEEP_0__ id.

__CAPGO_KEEP_0__

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

バージョン

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

デバイスID

型	プラグインバージョン
`deviceId`	`string`

セクションのタイトル “デバイスID”

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

自動更新有効

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

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

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

__CAPGO_KEEP_0__

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

不要イベント

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

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__

セクション「ダウンロード完了イベント」	プロパティ	概要	Since
`bundle`	`BundleInfo`	新バージョンが利用可能になったときに発生します。	4.0.0

MajorAvailableEvent

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

UpdateFailedEvent

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

DownloadFailedEvent

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

AppReadyEvent

Prop	Type	説明	Since
`bundle`	`BundleInfo`	アプリが利用可能になったときに発生します。	5.2.0
`status`	`string`

AutoUpdateAvailable

Prop	Type
`available`	`boolean`

SetShakeMenuOptions

Prop	Type
`enabled`	`boolean`

ShakeMenuEnabled

Prop	Type
`enabled`	`boolean`

Type Aliases

BundleStatus

pending: The bundle is pending to be セット __CAPGO_KEEP_0__を次のバンドルとして設定します。ダウンロード中: バンドルがダウンロード中です。成功: バンドルがダウンロードされ、使用可能になりました。 セット __CAPGO_KEEP_0__を次のバンドルとして設定します。エラー: バンドルがダウンロードできませんでした。

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

次のセクション

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

Functions and settingsから続けてください。

__CAPGO_KEEP_0__を使用している場合 Functions and settings APIを使用してダッシュボードとAPIの操作を計画する場合、APIを__CAPGO_KEEP_1__-updaterと接続してください。 capgo/capacitor-updaterを使用しています native capabilityの使用に@capgo/capacitor-updaterを使用します。 APIの概要 native capabilityの実装詳細についてはAPIの概要を参照してください。導入実装詳細についてはIntroductionを参照してください。 APIのキー実装詳細についてはAPIのキーを参照してください。デバイス実装詳細についてはDevicesを参照してください。

Functions と設定

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

例

メソッド

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

次(…)

set(…)

delete(…)

list(…)

戻り値:

current()

reload()

__CAPGO_KEEP_0__

cancelDelay()

getLatest(…)

setChannel(…)

unsetChannel(…) の説明

セクション “getChannel()”

listChannels()

タイトル： "setCustomId(…)"

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

removeAllListeners()

addListener('download', …)

addListener('noNeedUpdate', …)を追加します。

addListener('updateAvailable', ...) を呼び出す

addListener('downloadComplete', ...) を呼び出す

__CAPGO_KEEP_6__

updateFailed イベントリスナーを追加（…）

downloadFailed イベントリスナーを追加（…）

addListener('appReloaded', …)

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

isAutoUpdateAvailable()を呼び出す

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

インターフェイス

AppReadyResult

BundleInfo

UpdateUrl

StatsUrl

ChannelUrl

ダウンロードオプション

Delta (manifest) マルチファイルダウンロードのためのマニフェスト

BundleId

BundleListResult

ListOptions

ResetOptionsセクション

__CAPGO_KEEP_0__

MultiDelayConditionsのセクション

プロパティ

最新バージョン

GetLatestオプション

ChannelRes

SetChannelOptions

SetChannelOptionsを解除

GetChannelResを取得

ListChannelsResult

ChannelInfo

__CAPGO_KEEP_0__

バージョン

デバイスID

セクションのタイトル “デバイスID”

自動更新有効

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

__CAPGO_KEEP_0__

不要イベント

__CAPGO_KEEP_0__

__CAPGO_KEEP_0__

MajorAvailableEvent

UpdateFailedEvent

DownloadFailedEvent

AppReadyEvent

AutoUpdateAvailable

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