機能と設定

アップデータープラグイン構成

詳細については、Github Readme を参照してください。

CapacitorUpdater は次のオプションで構成できます。|小道具 |タイプ |説明 |デフォルト |以来 | | ---------------------------- | ----------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------------------------------------------- | ------- | | appReadyTimeout | 番号 |ネイティブプラグインが更新が「失敗」したと判断するまでに待機するミリ秒数を構成します。 Android、iOS、および Electron で利用可能です。 | 10000 // (10 秒) | | | responseTimeout | 番号 | API タイムアウトを考慮する前にネイティブプラグインが待機するミリ秒数を構成します。 Android、iOS、および Electron で利用可能です。 | 20000 // (20 秒) | | | autoDeleteFailed | ブール値 |プラグインが失敗したバンドルの自動削除を使用するかどうかを構成します。 Android、iOS、および E で利用可能レクトロン。 | true | | | autoDeletePrevious | ブール値 |プラグインが更新の成功後に以前のバンドルを自動的に削除するようにするかどうかを構成します。 Android、iOS、および Electron で利用可能です。 | true | | | autoUpdate | ブール値 |プラグインが更新サーバー経由の自動更新を使用するかどうかを構成します。 Android、iOS、および Electron で利用可能です。 | true | | | resetWhenUpdate | ブール値 |新しいネイティブアプリバンドルがデバイスにインストールされると、以前にダウンロードしたバンドルが自動的に削除されます。 Android、iOS、および Electron で利用可能です。 | true | | | updateUrl | string |更新チェックの送信先となる URL / エンドポイントを構成します。 Android、iOS、および Electron で利用可能です。| https://plugin.capgo.app/updates | | | channelUrl | 文字列 |チャネル操作の URL / エンドポイントを構成します。 Android、iOS、および Electron で利用可能です。 | https://plugin.capgo.app/channel_self | | | statsUrl | string |更新統計の送信先となる URL / エンドポイントを構成します。 Android、iOS、および Electron で利用可能です。統計レポートを無効にするには、「」に設定します。 | https://plugin.capgo.app/stats | | | publicKey | 文字列 |エンドツーエンドのライブアップデート暗号化バージョン 2 の公開キーを構成します。Android、iOS、および Electron で利用可能です。 | 未定義 | 6.2.0 | | version | 文字列 |アプリの現在のバージョンを構成します。これは最初の更新リクエストに使用されます。設定されていない場合、プラグインはネイティブコードからバージョンを取得します。 Android、iOS、および Electron で利用可能です。| 未定義 | 4.17.48 | | directUpdate | ブール値 | ‘常に’ | ‘atInstall’ | ‘起動時’ |プラグインがアップデートをいつインストールするかを設定します。自動更新モードのみ。 10MB 未満のアプリや —delta フラグを使用してアップロードを行う場合にうまく機能します。 10MB を超える ZIP やアプリは、ユーザーの更新に比較的時間がかかります。 - false: 直接更新を行わない (デフォルトの動作を使用: 開始時にダウンロード、バックグラウンド時に設定) - atInstall: アプリがインストールされたときのみ直接更新、ストアから更新、それ以外の場合は directUpdate = false として動作 - onLaunch: アプリがインストールされた場合のみ直接更新、ストアから更新またはアプリの強制終了後に更新、それ以外の場合は directUpdate = false として動作 - always: 以前のすべてのケース (アプリのインストール、ストアからの更新、アプリの強制終了またはアプリの再開後) で直接更新し、directUpdate = false として動作しない - true: (非推奨) 同じ下位互換性のために「常に」 Android、iOS、および Electron で使用できます。 | false | 5.1.0 | | autoSplashscreen | ブール値 | directUpdate の使用時にスプラッシュスクリーンの非表示を自動的に処理します。有効にすると、プラグインは更新が適用された後、または更新が必要ない場合に、スプラッシュスクリーンを自動的に非表示にします。これにより、手動で appReady イベントをリッスンして SplashScreen.hide() を呼び出す必要がなくなります。 directUpdate が「atInstall」、「always」、または true に設定されている場合にのみ機能します。 @capacitor/splash-screen プラグインをインストールし、launchAutoHide: false で構成する必要があります。 autoUpdate と directUpdate を有効にする必要があります。 Android および iOS で利用可能です。 | false | 7.6.0 | | periodCheckDelay | 番号 |期間更新チェックの遅延期間を設定します。単位は秒です。 Android、iOS、および Electron で利用可能です。 600 秒 (10 分) 未満にすることはできません。 | 600 // (10 分) | | | localS3 | ブール値 |テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。| 未定義 | 4.17.48 | | localHost | 文字列 |テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。 | 未定義 | 4.17.48 | | localWebHost | string |テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。 | 未定義 | 4.17.48 | | localSupa | 文字列 |テスト用のローカルサーバーまたは自己ホスト型更新サーバーを使用するように CLI を構成します。 | 未定義 | 4.17.48 | | localSupaAnon | string |テストにローカルサーバーを使用するように CLI を構成します。| 未定義 | 4.17.48 | | localApi | 文字列 |テストにローカル API を使用するように CLI を構成します。 | 未定義 | 6.3.3 | | localApiFiles | string |テストにローカルファイル API を使用するように CLI を構成します。 | 未定義 | 6.3.3 | | allowModifyUrl | ブール値 |プラグインが JavaScript 側から updateUrl、statsUrl、channelUrl を動的に変更できるようにします。 | false | 5.4.0 | | defaultChannel | string |構成でアプリのデフォルトのチャネルを設定します。大文字と小文字を区別。この設定はクラウドに設定されているデフォルトのチャネルをオーバーライドしますが、クラウドで行われたオーバーライドは引き続き尊重されます。 | 未定義 | 5.5.0 | | appId | string |構成でアプリのアプリ ID を構成します。 | 未定義 | 6.0.0 | | keepUrlPathAfterReload | ブール値 |リロード後に URL パスを保持するようにプラグインを構成します。警告: リロードがトリガーされると、「window.history」はクリアされます。 | false | 6.8.0 | | disableJSLogging | ブール値 |プラグインの JavaScript ログを無効にします。 true の場合、プラグインは JavaScript コンソールにログを記録しません。ネイティブログのみが実行されます。 false | 7.3.0 | | shakeMenu | ブール値 |デバッグ/テスト目的で更新メニューを表示するには、シェイクジェスチャを有効にします。 false | 7.5.0 |## 例

capacitor.config.json:

{
  "plugins": {
    "CapacitorUpdater": {
      "appReadyTimeout": 1000 // (1 second),
      "responseTimeout": 10 // (10 second),
      "autoDeleteFailed": false,
      "autoDeletePrevious": false,
      "autoUpdate": false,
      "resetWhenUpdate": false,
      "updateUrl": https://example.com/api/auto_update,
      "channelUrl": https://example.com/api/channel,
      "statsUrl": https://example.com/api/stats,
      "publicKey": undefined,
      "version": undefined,
      "directUpdate": undefined,
      "autoSplashscreen": undefined,
      "periodCheckDelay": undefined,
      "localS3": undefined,
      "localHost": undefined,
      "localWebHost": undefined,
      "localSupa": undefined,
      "localSupaAnon": undefined,
      "localApi": undefined,
      "localApiFiles": undefined,
      "allowModifyUrl": undefined,
      "defaultChannel": undefined,
      "appId": undefined,
      "keepUrlPathAfterReload": undefined,
      "disableJSLogging": undefined,
      "shakeMenu": undefined
    }
  }
}

capacitor.config.ts 内:

import { CapacitorConfig } from '@capacitor/cli';

const config: CapacitorConfig = {
  plugins: {
    CapacitorUpdater: {
      appReadyTimeout: 1000 // (1 second),
      responseTimeout: 10 // (10 second),
      autoDeleteFailed: false,
      autoDeletePrevious: false,
      autoUpdate: false,
      resetWhenUpdate: false,
      updateUrl: https://example.com/api/auto_update,
      channelUrl: https://example.com/api/channel,
      statsUrl: https://example.com/api/stats,
      publicKey: undefined,
      version: undefined,
      directUpdate: undefined,
      autoSplashscreen: undefined,
      periodCheckDelay: undefined,
      localS3: undefined,
      localHost: undefined,
      localWebHost: undefined,
      localSupa: undefined,
      localSupaAnon: undefined,
      localApi: undefined,
      localApiFiles: undefined,
      allowModifyUrl: undefined,
      defaultChannel: undefined,
      appId: undefined,
      keepUrlPathAfterReload: undefined,
      disableJSLogging: undefined,
      shakeMenu: undefined,
    },
  },
};

export default config;

notifyAppReady()
setUpdateUrl(...)
setStatsUrl(...)
setChannelUrl(...)
download(...)
next(...)
set(...)
delete(...)
list(...)
reset(...)
current()
reload()
setMultiDelay(...)
cancelDelay()
getLatest(...)
setChannel(...)
unsetChannel(...)
getChannel()
listChannels()
setCustomId(...)
getBuiltinVersion()
getDeviceId()
getPluginVersion()
isAutoUpdateEnabled()
removeAllListeners()
addListener('download', ...)
addListener('noNeedUpdate', ...)
addListener('updateAvailable', ...)
addListener('downloadComplete', ...)
addListener('majorAvailable', ...)
addListener('updateFailed', ...)
addListener('downloadFailed', ...)
addListener('appReloaded', ...)
addListener('appReady', ...)
isAutoUpdateAvailable()
getNextBundle()
setShakeMenu(...)
isShakeMenuEnabled()
インターフェース
タイプエイリアス

メソッド

通知AppReady()

notifyAppReady() => Promise<AppReadyResult>

現在のバンドルが機能していることを Capacitor Updater に通知します (アプリの起動ごとにこのメソッドが呼び出されないとロールバックが発生します) デフォルトでは、このメソッドはアプリ起動後の最初の 10 秒以内に呼び出される必要があります。そうしないとロールバックが発生します。この動作を {@link appReadyTimeout} で変更します

戻り値: Promise<AppReadyResult>

setUpdateUrl(…)

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

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

パラム	タイプ	説明
`options`	`UpdateUrl`	更新の確認に使用する URL が含まれています。

以降: 5.4.0

setStatsUrl(…)

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

アプリの statsUrl を設定します。これは統計の送信に使用されます。空の文字列を渡すと、統計の収集が無効になります。|パラム |タイプ | Description | | ------------- | ----------------------------------------------- | ----------------------------------------------- | | options | StatsUrl |統計の送信に使用する URL が含まれています。 |

以降: 5.4.0

setChannelUrl(…)

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

Set the channelUrl for the app, this will be used to set the channel.

パラム	Type	Description
`options`	`ChannelUrl`	チャネルの設定に使用する URL が含まれています。

以降: 5.4.0

ダウンロード(…)

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

Download a new bundle from the provided URL, it should be a zip file, with files inside or with a unique id inside with all your files

パラム	タイプ	Description
`options`	`ダウンロードオプション`	新しいバンドル zip をダウンロードするための {@link DownloadOptions}。

Returns: Promise<BundleInfo>

次(…)

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

アプリのリロード時に使用される次のバンドルを設定します。

パラム	タイプ	Description
`options`	`バンドルID`	次回のアプリ起動時に設定する次のバンドルの ID が含まれます。 {@link BundleInfo.id}

戻り値: 約束<バンドル情報>

セット(…)

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

現在のバンドルを設定し、すぐにアプリをリロードします。|パラム |タイプ |説明 | | ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------- | | options | バンドルID |現在として設定する新しいバンドル ID を含む {@link BundleId} オブジェクト。 |

削除(…)

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

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

パラム	タイプ	説明
`options`	`バンドルID`	削除するバンドルの ID を含む {@link BundleId} オブジェクト (これはバンドル ID であり、バージョン名ではないことに注意してください)

リスト(…)

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

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

パラム	タイプ	説明
`options`	`リストオプション`	バンドルをリストするための {@link ListOptions}

戻り値: 約束<BundleListResult>

リセット(…)

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

アプリを builtin バンドル ( Apple App Store / Google Play ストアに送信されたもの) または最後に正常にロードされたバンドルにリセットします。

パラム	タイプ	説明
`options`	`リセットオプション`	{@link ResetOptions.toLastSuccessful} を含む、`true` は組み込みバンドルにリセットされ、`false` は最後に正常にロードされたバンドルにリセットされます。

現在()

current() => Promise<CurrentBundleResult>
```現在のバンドルを取得します。何も設定されていない場合は、`builtin` を返します。 currentNative はデバイスにインストールされている元のバンドルです

**戻り値:** <code>約束<<a href="#currentbundleresult">CurrentBundleResult</a>></code>

--------------------


## リロード()

```typescript
reload() => Promise<void>

ビューをリロードする

setMultiDelay(…)

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

プラグインが更新を遅らせるために使用する条件を含む {@link DelayCondition} 配列を設定します。すべての条件が満たされると、更新プロセスが通常どおりに再び実行され、アプリのバックグラウンド化または終了後に更新がインストールされます。 date 種類の場合、値は iso8601 日付文字列である必要があります。 background 種類の場合、値はミリ秒単位の数値である必要があります。 nativeVersion 種類の場合、値はバージョン番号である必要があります。 kill 種類の場合、値は使用されません。この関数には一貫性のない動作があり、オプション kill では、他のオプションのように次のバックグラウンドの後ではなく、最初の kill 後に更新がトリガーされます。これは将来のメジャーリリースで修正される予定です。

パラム	タイプ	説明
`options`	`MultiDelayConditions`	設定する条件の {@link MultiDelayConditions} 配列が含まれています

以降: 4.3.0

cancelDelay()

cancelDelay() => Promise<void>

{@link DelayCondition} をキャンセルして、更新をすぐに処理します。

以降: 4.0.0

getlatest(…)

getLatest(options?: GetLatestOptions | undefined) => Promise<LatestVersion>

アップデート URL から最新のバンドルを入手

パラム	タイプ
`options`	`最新オプションの取得`

戻り値: 約束<最新バージョン>

以降: 4.0.0

setChannel(…)

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

このデバイスのチャンネルを設定します。これが機能するには、チャネルで allow_device_self_set が有効になっている必要があります。このデバイスのカスタム ID を設定する

パラム	タイプ	説明
`options`	`SetCustomIdOptions`	は、設定する {@link SetCustomIdOptions} カスタム ID です

以降: 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

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

戻り値: 約束<BuiltinVersion>

以降: 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

デバイスを識別するために使用される固有の ID を取得します (自動更新サーバーに送信されます)。

戻り値: 約束<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

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

戻り値: 約束<プラグインバージョン>

isAutoUpdateEnabled()

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

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

戻り値: 約束<AutoUpdateEnabled>

削除AllListeners()

removeAllListeners() => Promise<void>

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

以降: 1.0.0

addListener(‘ダウンロード’, …)

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

アプリでバンドルのダウンロードイベントをリッスンします。ダウンロードの開始時、ダウンロード中、終了時に発生します。これにより、ダウンロード中にすべてのダウンロードパーセントが返されます

パラム	タイプ
`eventName`	`「ダウンロード」`
`listenerFunc`	`(状態: DownloadEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 2.0.11

addListener(‘noNeedUpdate’, …)

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

イベントを更新する必要がないためリッスンします。アプリが起動されるたびに強制的にチェックしたい場合に便利です

パラム	タイプ
`eventName`	`’アップデートは必要ありません’`
`listenerFunc`	`(状態: NoNeedEvent) => void`

以降: 4.0.0

addListener(‘updateAvailable’, …)

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

利用可能な更新イベントをリッスンします。アプリが起動されるたびに強制的にチェックしたい場合に便利です。

パラム	タイプ
`eventName`	`’アップデートあり’`
`listenerFunc`	`(状態: UpdateAvailableEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 4.0.0

addListener(‘downloadComplete’, …)

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

downloadComplete イベントをリッスンします。

パラム	タイプ
`eventName`	`’ダウンロード完了’`
`listenerFunc`	`(状態: DownloadCompleteEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 4.0.0

addListener(‘majorAvailable’, …)

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

アプリでメジャーアップデートイベントをリッスンし、disableAutoUpdateBreaking を設定することでメジャーアップデートがブロックされたときに通知します。

パラム	タイプ
`eventName`	`’メジャー利用可能’`
`listenerFunc`	`(状態: MajorAvailableEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 2.3.0

addListener(‘updateFailed’, …)

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

アプリ内で更新失敗イベントをリッスンし、次回のアプリ起動時に更新のインストールに失敗したことを通知します

パラム	タイプ
`eventName`	`’更新失敗’`
`listenerFunc`	`(状態: UpdateFailedEvent) => void`

以降: 2.3.0

addListener(‘ダウンロード失敗’, …)

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

アプリでダウンロード失敗イベントをリッスンし、バンドルのダウンロードが失敗したときに通知します

パラム	タイプ
`eventName`	`’ダウンロード失敗’`
`listenerFunc`	`(状態: DownloadFailedEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 4.0.0

addListener(‘appReloaded’, …)

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

アプリでリロードイベントをリッスンし、リロードが発生したときに通知します

パラム	タイプ
`eventName`	`’アプリが再ロードされました’`
`listenerFunc`	`() => void`

戻り値: Promise<PluginListenerHandle>

以降: 4.3.0

addListener(‘appReady’, …)

addListener(eventName: 'appReady', listenerFunc: (state: AppReadyEvent) => void) => Promise<PluginListenerHandle>

アプリ内でアプリ準備完了イベントをリッスンし、アプリが使用できるようになったときに通知します

パラム	タイプ
`eventName`	`’アプリ準備完了’`
`listenerFunc`	`(状態: AppReadyEvent) => void`

戻り値: Promise<PluginListenerHandle>

以降: 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

自動更新が利用可能かどうかを取得します (serverUrl によって無効になっていない)。

戻り値: 約束<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

Get the next bundle that will be used when the app reloads. 次のバンドルが設定されていない場合は null を返します。

戻り値: 約束<バンドル情報 | null>

以降: 6.8.0

setShakeMenu(…)

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

デバッグ/テスト目的でシェイクメニューを有効または無効にします。|パラム |タイプ |説明 | | ------------- | ------------------------------------------------------------------- | -------------------------------------------------------- | | options | SetShakeMenuOptions |シェイクメニューを有効または無効にするための有効なブール値が含まれます |

以降: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

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

戻り値: 約束<ShakeMenuEnabled>

以降: 7.5.0

インターフェース

AppReady結果

小道具	タイプ
`bundle`	`バンドル情報`

バンドル情報

小道具	タイプ
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`バンドルステータス`

更新URL

小道具	タイプ
`url`	`string`

統計URL

小道具	タイプ
`url`	`string`

チャンネルURL

小道具	タイプ
`url`	`string`

ダウンロードオプション

この URL とバージョンは、サーバーからバンドルをダウンロードするために使用されます。バックエンドを使用する場合は、すべての情報が getlatest メソッドによって提供されます。バックエンドを使用しない場合は、バンドルの URL とバージョンを指定する必要があります。 CLI コマンド encrypt を使用してバンドルを暗号化した場合は、チェックサムとセッションキーが必要です。これらはコマンドの結果として受け取る必要があります。|小道具 |タイプ |説明 |デフォルト |以来 | | ---------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------- | ----- | | url | string |ダウンロードするバンドル zip ファイル (例: dist.zip) の URL。 (これは任意の URL にすることができます。例: Amazon S3、GitHub タグ、バンドルをホストしているその他の場所。) | | | version | string |このバンドル/バージョンのバージョンコード/名前 | | | | sessionKey | string |バンドルがセッションキーで暗号化されている場合の更新用のセッションキー | 未定義 | 4.0.0 | | checksum | string |アップデートのチェックサム。バンドルが暗号化されている場合は、sha256 で秘密キーで暗号化されている必要があります。 未定義 | 4.0.0 | | manifest | ManifestEntry[] |デルタ (マニフェスト) マルチファイルダウンロードのマニフェスト | 未定義 | 6.1.0 |

マニフェストエントリ

小道具	タイプ
`file_name`	`文字列 \| null`
`file_hash`	`文字列 \| null`
`download_url`	`文字列 \| null`

BundleId

小道具	タイプ
`id`	`string`

バンドルリスト結果

小道具	タイプ
`bundles`	`バンドル情報[]`

リストオプション|小道具 |タイプ |説明 |デフォルト |以来 |

| --------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ | ------ | | raw | ブール値 |生のバンドルリストを返すかマニフェストを返すか。 true の場合、リストはディスク上のファイルではなく内部データベースの読み取りを試みます。 | false | 6.14.0 |

リセットオプション

Prop	タイプ
`toLastSuccessful`	`ブール値`

現在のバンドル結果

小道具	タイプ
`bundle`	`バンドル情報`
`native`	`string`

マルチ遅延条件

小道具	タイプ
`delayConditions`	`遅延条件[]`

遅延条件

小道具	タイプ	説明
`kind`	`次まで遅延`	setMultiDelay
`value`	`string`

GetlatestOptions

小道具	タイプ	説明	デフォルト	以来
`channel`	`string`	最新バージョンを取得するチャネルこのチャネルが機能するには、「self_assign」を許可する必要があります。 `未定義`	6.8.0

チャンネル解像度

小道具	タイプ	説明	以来
`status`	`string`	設定チャンネルの現在の状態	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

小道具	タイプ
`channel`	`string`
`triggerAutoUpdate`	`ブール値`

UnsetChannelOptions

小道具	タイプ
`triggerAutoUpdate`	`ブール値`

GetChannelRes|小道具 |タイプ |説明 |以来 |

| -------------- | -------------------- | ----------------------------- | ----- | | channel | string |チャンネル取得の現在のステータス | 4.8.0 | | error | string | | | | message | string | | | | status | string | | | | allowSet | ブール値 | | |

ListChannelsResult

小道具	タイプ	説明	以来
`channels`	`チャンネル情報[]`	利用可能なチャンネルのリスト	7.5.0

チャンネル情報

小道具	タイプ	説明	以来
`id`	`string`	チャンネル ID	7.5.0
`name`	`string`	チャンネル名	7.5.0
`public`	`ブール値`	true の場合、これはデフォルト/フォールバックチャネルです。デバイスはパブリックチャネルに自己割り当てできません。代わりに、デバイスがチャネルオーバーライドを削除すると (`unsetChannel()` を使用)、一致するパブリックチャネルから更新を自動的に受信します。	7.5.0
`allow_self_set`	`ブール値`	true の場合、デバイスは `setChannel()` を使用してこのチャネルに明示的に自己割り当てできます。これは通常、ベータテスト、A/B テスト、またはオプトイン更新トラックに使用されます。	7.5.0

SetCustomIdOptions

小道具	タイプ
`customId`	`string`

組み込みバージョン

小道具	タイプ
`version`	`string`

デバイス ID

小道具	タイプ
`deviceId`	`string`

プラグインのバージョン

小道具	タイプ
`version`	`string`

自動更新が有効です

小道具	タイプ
`enabled`	`ブール値`

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

小道具	タイプ
`remove`	`() => 約束`

DownloadEvent|小道具 |タイプ |説明 |以来 |

| ------------- | -------------------------------------------------- | ------------------------------------------------ | ----- | | percent | 番号 |ダウンロードの現在のステータス (0 ～ 100)。 4.0.0 | | bundle | バンドル情報 | | |

必要のないイベント

小道具	タイプ	説明	以来
`bundle`	`バンドル情報`	ダウンロードの現在のステータス (0 ～ 100)。 4.0.0

UpdateAvailableEvent

小道具	タイプ	説明	以来
`bundle`	`バンドル情報`	ダウンロードの現在のステータス (0 ～ 100)。 4.0.0

ダウンロード完了イベント

小道具	タイプ	説明	以来
`bundle`	`バンドル情報`	新しいアップデートが利用可能になったときに発行されます。	4.0.0

MajorAvailableEvent

小道具	タイプ	説明	以来
`version`	`string`	新しいメジャーバンドルが利用可能になったときに発行されます。	4.0.0

更新失敗イベント

小道具	タイプ	説明	以来
`bundle`	`バンドル情報`	アップデートのインストールに失敗した場合に発行されます。	4.0.0

DownloadFailedEvent

小道具	タイプ	説明	以来
`version`	`string`	ダウンロードが失敗したときに発行されます。	4.0.0

AppReadyイベント|小道具 |タイプ |説明 |以来 |

| ------------ | -------------------------------------------------- | ------------------------------------- | ----- | | bundle | バンドル情報 |アプリを使用する準備ができたときに発行されます。 | 5.2.0 | | status | string | | |

自動更新が利用可能

小道具	タイプ
`available`	`ブール値`

SetShakeMenuOptions

小道具	タイプ
`enabled`	`ブール値`

ShakeMenuEnabled

小道具	タイプ
`enabled`	`ブール値`

タイプエイリアス

バンドルのステータス

pending: バンドルは次のバンドルとして SET されるまで保留中です。ダウンロード中: バンドルをダウンロード中です。成功: バンドルはダウンロードされ、次のバンドルとして SET する準備ができています。エラー: バンドルのダウンロードに失敗しました。

「成功」 | ‘エラー’ | ‘保留中’ | ‘ダウンロード中’

次までの遅延

‘背景’ | ‘殺す’ | ‘ネイティブバージョン’ | ‘日付’

機能と設定

アップデータープラグイン構成

メソッド

通知AppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

ダウンロード(…)

次(…)

セット(…)

削除(…)

リスト(…)

リセット(…)

現在()

setMultiDelay(…)

cancelDelay()

getlatest(…)

setChannel(…)

getBuiltinVersion()

getDeviceId()

getPluginVersion()

isAutoUpdateEnabled()

削除AllListeners()

addListener(‘ダウンロード’, …)

addListener(‘noNeedUpdate’, …)

addListener(‘updateAvailable’, …)

addListener(‘downloadComplete’, …)

addListener(‘majorAvailable’, …)

addListener(‘updateFailed’, …)

addListener(‘ダウンロード失敗’, …)

addListener(‘appReloaded’, …)

addListener(‘appReady’, …)

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

インターフェース

AppReady結果

バンドル情報

更新URL

統計URL

チャンネルURL

ダウンロードオプション

マニフェストエントリ

BundleId

バンドルリスト結果

リストオプション|小道具 |タイプ |説明 |デフォルト |以来 |

リセットオプション

現在のバンドル結果

マルチ遅延条件

遅延条件

最新バージョン|小道具 |タイプ |説明 |以来 |

GetlatestOptions

チャンネル解像度

SetChannelOptions

UnsetChannelOptions

GetChannelRes|小道具 |タイプ |説明 |以来 |

ListChannelsResult

チャンネル情報

SetCustomIdOptions

組み込みバージョン

デバイス ID

プラグインのバージョン

自動更新が有効です

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

DownloadEvent|小道具 |タイプ |説明 |以来 |

必要のないイベント

UpdateAvailableEvent

ダウンロード完了イベント

MajorAvailableEvent

更新失敗イベント

DownloadFailedEvent

AppReadyイベント|小道具 |タイプ |説明 |以来 |

自動更新が利用可能

SetShakeMenuOptions

ShakeMenuEnabled

タイプエイリアス

バンドルのステータス

次までの遅延