功能和设置

复制一个包含安装步骤和本插件完整 Markdown 指南的设置提示。

Updater Plugin Config

See the Github Readme for more information.

CapacitorUpdater can be configured with these options:

Prop	Type	描述	Default	自
`appReadyTimeout`	`number`	配置 native 插件在等待更新失败之前等待的毫秒数。可用于 Android、iOS 和 Electron。	`10000 // (10 seconds)`
`responseTimeout`	`number`	配置 native 插件在等待 API 超时之前等待的毫秒数。可用于 Android、iOS 和 Electron。	`20000 // (20 seconds)`
`autoDeleteFailed`	`boolean`	配置是否应使用自动删除失败的捆绑包。可用于 Android、iOS 和 Electron。	`true`
`autoDeletePrevious`	`boolean`	配置是否应在成功更新后使用自动删除之前的捆绑包。可用于 Android、iOS 和 Electron。	`true`
`autoUpdate`	`boolean \| ‘off’ \| ‘atBackground’ \| ‘atInstall’ \| ‘onLaunch’ \| ‘always’ \| ‘onlyDownload’`	配置如何使用 Auto Update 通过更新服务器。true 与“atBackground”相同；false 与“off”相同。- off：禁用 Auto Update- atBackground：在应用程序移动到后台时自动检查和下载，然后在应用程序移动到后台时应用- atInstall：仅在新安装或本机应用程序更新后立即应用，否则使用 atBackground- onLaunch：在启动时立即应用，否则在启动检查后使用 atBackground- always：在 Auto Update 运行时立即应用- onlyDownload：自动检查和下载，发出 updateAvailable，永不设置下一个捆绑包。可用于 Android、iOS 和 Electron。	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	自动删除设备上安装的新 native 应用捆绑包时的之前下载的捆绑包。可用于 Android、iOS 和 Electron。	`true`
`updateUrl`	`string`	配置更新检查将发送到的 URL / 端点。可用于 Android、iOS 和 Electron。	`https://plugin.capgo.app/updates`
`channelUrl`	`string`	Configure the URL / endpoint for channel operations. Available on Android, iOS, and Electron.	`https://plugin.capgo.app/channel_self`
`statsUrl`	`string`	Configure the URL / endpoint to which update statistics are sent. Available on Android, iOS, and Electron. Set to "" to disable stats reporting.	`https://plugin.capgo.app/stats`
`publicKey`	`string`	Configure the public key for end to end live update encryption Version 2. Available on Android, iOS, and Electron.	`undefined`	6.2.0
`version`	`string`	Configure the current version of the app. This will be used for the first update request. If not set, the plugin will get the version from the native code. Available on Android, iOS, and Electron.	`undefined`	4.17.48
`directUpdate`	`boolean \| ‘always’ \| ‘atInstall’ \| ‘onLaunch’`	Deprecated. Use autoUpdate string modes instead: “atInstall”，“onLaunch”， or “always”. This option remains supported for existing apps. - false: Never do direct updates - atInstall: Same as autoUpdate: “atInstall” - onLaunch: Same as autoUpdate: “onLaunch” - always: Same as autoUpdate: “always” - true: Same as “always” for backward compatibility. Available on Android, iOS, and Electron.	`false`	5.1.0
`autoSplashscreen`	`boolean`	自动隐藏启动屏幕，当使用即时应用模式时。当启用时，插件将在应用程序更新或无需更新时自动隐藏启动屏幕。这消除了手动监听 appReady 事件并调用 SplashScreen.hide() 的需要。只有在 autoUpdate 设置为“atInstall”，“onLaunch”或“always”时才有效。为了向后兼容，仍支持 Legacy directUpdate 值。需要安装并配置 @capacitor/splash-screen 插件，launchAutoHide 设置为 false。需要启用自动更新。可用于 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日志的插件。如果为真，插件将不会在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，用于检查更新。

参数	类型	描述
`options`	`UpdateUrl`	包含用于检查更新的 URL。

自： 5.4.0

setStatsUrl(…)

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

设置应用程序的 statsUrl，用于发送统计数据。传入空字符串将禁用统计数据收集。

参数	类型	描述
`options`	`StatsUrl`	用于发送统计数据的 URL。

自: 5.4.0

setChannelUrl(…)

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

为应用设置 channelUrl，这将用于设置 channel。

参数	类型	描述
`options`	`ChannelUrl`	用于设置 channel 的 URL。

自: 5.4.0

download(…)

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

从提供的 URL 下载一个新的压缩包，应该是一个 zip 文件，或者一个包含所有文件的 id

参数	类型	描述
`options`	`DownloadOptions`	用于下载一个新的压缩包 zip 的 {@link DownloadOptions}

返回： Promise<BundleInfo>

next（…）

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

在应用程序重新加载时使用的下一个捆绑包设置为

参数	类型	描述
`options`	`BundleId`	包含应用程序下一次启动时设置的下一个捆绑包的ID。 {@link BundleInfo.id}

返回值 Promise<BundleInfo>

set(…)

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

设置当前捆绑包并立即重新加载应用程序。

参数	类型	描述
`options`	`BundleId`	一个 {@link BundleId} 对象，包含要设置为当前的新包ID。

delete(…)

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

从原生应用程序存储中删除指定的包。使用 {@link list} 来获取存储的 Bundle IDs。

参数	类型	描述
`options`	`BundleId`	A {@link BundleId}对象包含要删除的捆绑包的ID（注意，这是捆绑包ID，而不是版本名称）

list(…)

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

获取本地下载的所有捆绑包

参数	类型	描述
`options`	`ListOptions`	The {@link 列表选项}用于列出捆绑包

返回: Promise<BundleListResult>

重置（…）

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

重置应用到 builtin 捆绑包（发送到苹果应用商店/谷歌商店）或最后成功加载的捆绑包。

参数	类型	描述
`options`	`ResetOptions`	包含{@link} 重置到最后一次成功加载的包}, `true` 重置到内置的包并 `false` 将重置到最后一次成功加载的包

当前（）

current() => Promise<CurrentBundleResult>

如果没有设置任何包，则返回当前的包。currentNative是设备上安装的原始包 builtin返回：

重载（） Promise<CurrentBundleResult>

标题：重载（）

reload() => Promise<void>

重新加载视图

__CAPGO_KEEP_0__

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

__CAPGO_KEEP_0__：设置一个延迟条件数组，Plugin将使用此数组中的条件来延迟更新。在所有条件都满足后，更新过程将重新启动，更新将在后台或杀死应用后安装。对于"kind"，值应为ISO8601日期字符串。对于"kind"，值应为毫秒数。对于"kind"，值应为版本号。对于"kind"，值不被使用。此函数的行为不一致，选项"kill"将触发更新，但在第一次杀死应用后而不是在下一次后台运行时。此问题将在未来重大版本中得到解决。 ParamDelayCondition date __CAPGO_KEEP_0__ background __CAPGO_KEEP_0__ nativeVersion __CAPGO_KEEP_0__ kill __CAPGO_KEEP_0__

__CAPGO_KEEP_0__	类型	描述
`options`	`MultiDelayConditions`	包含 {@link 多延迟条件} 数组的条件来设置

自 4.3.0

取消延迟()

cancelDelay() => Promise<void>

取消一个 {@link 延迟条件} 来立即处理更新

自： 4.0.0

getLatest(…)

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

获取最新的可用更新包

参数	类型
`options`	`GetLatestOptions`

返回： Promise<LatestVersion>

自： 4.0.0

setChannel(…)

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

设置此设备的插件管理的本地频道。频道必须 allow_device_self_set 必须启用才能正常工作。

setChannel() 验证频道与后端，然后将选定的频道存储在本地设备上。它不会创建或更新后端设备覆盖，因此设备不会在Capgo控制台中显示为覆盖。只有从控制台或公共API创建的 assignments 才会在设备覆盖 UI 中显示。

重要注意事项：

不要使用此方法在启动时设置频道。使用 defaultChannel 在您的Capacitor配置中。
此方法旨在在应用程序准备好并用户已交互（例如，选择参加beta测试）后使用。
公共频道无法自行分配。 如果频道标记为 public, setChannel() ,则调用 unsetChannel() 将返回错误。要使用公共频道，请调用
使用 listChannels() 来发现哪些频道可用并且是否允许自我赋值。

参数	类型	描述
`options`	`SetChannelOptions`	是否设置 {@link SetChannelOptions} 频道

返回: Promise<ChannelRes>

自: 4.7.0

unsetChannel(…)

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

清除本地设备的插件管理的频道。该操作仅清除本地存储的频道， setChannel()不删除仪表盘或公共API设备Override记录。

调用此方法后，正常频道顺序适用：存在仪表盘或公共API设备Override仍然有效；否则设备可以回落到匹配公共/默认频道（根据平台、设备类型、构建类型）

此功能有用时：

您想将设备恢复到默认更新跟踪
您想使用公共频道（由于公共频道无法自行分配via setChannel())

Param	Type
`options`	`UnsetChannelOptions`

Since: 4.7.0

getChannel()

getChannel() => Promise<GetChannelRes>

获取该设备的频道

返回: Promise<GetChannelRes>

自: 4.8.0

listChannels()

listChannels() => Promise<ListChannelsResult>

列出该设备可用的所有频道。返回与设备当前环境（平台、模拟器/真实设备、开发/生产构建）兼容的公共频道或允许自我赋值的频道。

结果中的每个频道包括:

public如果 true,这是一个 默认频道. 你不能使用自行分配给它。 setChannel(). 如果您移除您的频道分配使用 unsetChannel(), 设备将自动从此公共频道接收更新。
allow_self_set: 如果 true, 这是 自分配频道。您可以使用 setChannel().

返回: Promise<ListChannelsResult>

自 7.5.0

setCustomId(…)

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

设置一个自定义 ID 以标识此设备

参数	类型	描述
`options`	`SetCustomIdOptions`	是 {@link SetCustomIdOptions} 中的自定义 ID

自 4.9.0

getBuiltinVersion()

getBuiltinVersion() => Promise<BuiltinVersion>

获取本机应用程序版本或配置中设置的内置版本

Returns: Promise<BuiltinVersion>

自从： 5.2.0

getDeviceId()

getDeviceId() => Promise<DeviceId>

获取用于识别设备的唯一 ID（发送到自动更新服务器）

Returns: Promise<DeviceId>

getPluginVersion()

getPluginVersion() => Promise<PluginVersion>

获取本机 Capacitor 更新器插件版本（发送到自动更新服务器）

Returns: Promise<PluginVersion>

是否自动更新功能启用？

isAutoUpdateEnabled() => Promise<AutoUpdateEnabled>

获取自动更新配置状态。

返回： Promise<AutoUpdateEnabled>

removeAllListeners()

removeAllListeners() => Promise<void>

移除此插件的所有监听器。

自： 1.0.0

addListener（‘download’，…）

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

在 App 中监听包下载事件。触发一次下载开始、下载中和下载完成时。此事件将返回下载百分比

参数	类型
`eventName`	`’download’`
`listenerFunc`	`(state: DownloadEvent) => void`

返回: Promise<PluginListenerHandle>

自: 2.0.11

添加监听器（‘无需更新’，…）

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

监听无需更新事件，适用于每次启动应用时强制检查

参数	类型
`eventName`	`’noNeedUpdate’`
`listenerFunc`	`(state: NoNeedEvent) => void`

返回: Promise<PluginListenerHandle>

自: 4.0.0

添加监听器（‘updateAvailable’，…）

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

监听可用更新事件，适用于每次启动应用时强制检查

参数	类型
`eventName`	`’updateAvailable’`
`listenerFunc`	`(state: UpdateAvailableEvent) => void`

返回: Promise<PluginListenerHandle>

自: 4.0.0

添加监听器（‘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>

在 App 中监听 Major 更新事件，让您知道当设置 disableAutoUpdateBreaking 时，是否有重大更新被阻止

参数	类型
`eventName`	`’majorAvailable’`
`listenerFunc`	`(state: MajorAvailableEvent) => void`

Returns: Promise<PluginListenerHandle>

Since: 2.3.0

添加监听器（updateFailed，…）

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

在 App 中监听更新失败事件，通知您下次启动应用时更新安装失败

Param	Type
`eventName`	`’updateFailed’`
`listenerFunc`	`(state: UpdateFailedEvent) => void`

Returns: Promise<PluginListenerHandle>

Since: 2.3.0

添加监听器（downloadFailed，…）

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

在 App 中监听下载失败事件，让你知道一个捆绑包下载失败了

参数	类型
`eventName`	`’downloadFailed’`
`listenerFunc`	`(state: DownloadFailedEvent) => void`

返回： Promise<PluginListenerHandle>

自： 4.0.0

addListener（‘appReloaded’，…）

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

在 App 中监听重载事件，让你知道重载已经发生

参数	类型
`eventName`	`’appReloaded’`
`listenerFunc`	`() => void`

Returns: Promise<PluginListenerHandle>

自从： 4.3.0

addListener(‘appReady’, …)

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

在 App 中监听 app ready 事件，让你知道 app 已经准备好使用

参数	类型
`eventName`	`’appReady’`
`listenerFunc`	`(state: AppReadyEvent) => void`

Returns: Promise<PluginListenerHandle>

自从： 5.1.0

isAutoUpdateAvailable()

isAutoUpdateAvailable() => Promise<AutoUpdateAvailable>

获取是否有可用的自动更新（不受serverUrl禁用）。

返回值： Promise<AutoUpdateAvailable>

getNextBundle()

getNextBundle() => Promise<BundleInfo | null>

获取将在应用重载时使用的下一个捆绑包。如果没有设置下一个捆绑包，则返回 null。

返回值： Promise<BundleInfo | null>

自： 6.8.0

setShakeMenu(…)

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

Enable or disable the shake menu for debugging/testing purposes

Param	Type	Description
`options`	`SetShakeMenuOptions`	Contains enabled boolean to enable or disable shake menu

Since: 7.5.0

isShakeMenuEnabled()

isShakeMenuEnabled() => Promise<ShakeMenuEnabled>

Get the current state of the shake menu

Returns: Promise<ShakeMenuEnabled>

Since: 7.5.0

界面

AppReadyResult

属性	类型
`bundle`	`BundleInfo`

BundleInfo

属性	类型
`id`	`string`
`version`	`string`
`downloaded`	`string`
`checksum`	`string`
`status`	`BundleStatus`

UpdateUrl

属性	类型
`url`	`string`

统计URL

属性	类型
`url`	`string`

频道URL

下载选项	下载选项部分
`url`	`string`

__CAPGO_KEEP_0__

此 URL 和版本用于从服务器下载捆绑包。如果您使用后端，则所有信息都将通过方法 getLatest 提供。如果您不使用后端，则需要提供捆绑包的 URL 和版本。若捆绑包使用 CLI 命令加密，则需要 SessionKey，应从加密命令的结果中接收。

属性	类型	描述	默认值	自
`url`	`string`	捆绑包 zip 文件的 URL (例如：dist.zip)，用于下载。 (此 URL 可以是任何 URL。例如：Amazon S3，一个 GitHub 标签，任何您托管的捆绑包的位置。)
`version`	`string`	捆绑包的版本 code/name
`sessionKey`	`string`	用于更新的会话密钥，当捆绑包使用会话密钥加密时	`undefined`	4.0.0
`checksum`	`string`	用于更新的校验和，应使用 sha256 并加密私钥，如果捆绑包加密	`undefined`	4.0.0
`manifest`	`ManifestEntry[]`	Delta (manifest) 多文件下载的清单	`undefined`	6.1.0

清单条目

属性	类型
`file_name`	`string \| null`
`file_hash`	`string \| null`
`download_url`	`string \| null`

BundleId

属性	类型
`id`	`string`

BundleListResult

类型	ListOptions
`bundles`	`BundleInfo[]`

列表选项

属性	类型	描述	默认值	自
`raw`	`boolean`	是否返回原始包列表或清单。如果为真，列表将尝试读取内部数据库而不是磁盘上的文件。	`false`	6.14.0

ResetOptions

类型	当前包结果
`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

获取最新选项

属性	类型	描述	默认	自
`channel`	`string`	获取最新版本的频道必须允许 '自我分配' 才能工作	`undefined`	6.8.0

ChannelRes

Prop	Type	描述	自
`status`	`string`	设置的频道当前状态	4.7.0
`error`	`string`
`message`	`string`

SetChannelOptions

属性	类型
`channel`	`string`
`triggerAutoUpdate`	`boolean`

清除频道选项

属性	类型
`triggerAutoUpdate`	`boolean`

获取频道结果

属性	类型	描述	自从
`channel`	`string`	获取频道的当前状态	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

Prop	类型	描述	自从
`channels`	`ChannelInfo[]`	可用的频道列表	7.5.0

ChannelInfo

属性	类型	描述	自
`id`	`number`	数字通道ID	7.5.0
`name`	`string`	通道名称	7.5.0
`public`	`boolean`	如果为真，这是默认/备份通道。设备无法自行将其分配到公共通道。相反，当设备使用（）移除其通道覆盖时，它将自动从匹配的公共通道接收更新。 `unsetChannel()`如果为真，设备可以使用（）明确将其分配到此通道。通常用于beta测试、A/B测试或优选更新跟踪。	7.5.0
`allow_self_set`	`boolean`	通道命令使用通道 `setChannel()`,而不是数字	7.5.0

设置自定义ID选项 name__CAPGO_KEEP_0__ id.

__CAPGO_KEEP_0__

属性	类型
`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`

无需事件

类型	描述	自	下载进度，范围为 0 到 100。
`bundle`	`BundleInfo`	下载进度，范围为 0 到 100。	4.0.0

UpdateAvailableEvent

Prop	Type	描述	自
`bundle`	`BundleInfo`	下载进度，范围为 0 到 100。	4.0.0

DownloadCompleteEvent

Prop	Type	描述	自
`bundle`	`BundleInfo`	当有新版本可用时发出。	4.0.0

MajorAvailableEvent

属性	类型	描述	自
`version`	`string`	当有新主要捆绑包可用时发出。	4.0.0

UpdateFailedEvent

属性	类型	描述	自
`bundle`	`BundleInfo`	当更新安装失败时发出。	4.0.0

DownloadFailedEvent

属性	类型	描述	自
`version`	`string`	当下载失败时发出.	4.0.0

AppReadyEvent

属性	类型	描述	自
`bundle`	`BundleInfo`	应用程序准备好使用时发射。	5.2.0
`status`	`string`

AutoUpdateAvailable

属性	类型
`available`	`boolean`

设置抖动菜单选项

属性	类型
`enabled`	`boolean`

ShakeMenuEnabled

属性	类型
`enabled`	`boolean`

类型别名

BundleStatus

pending: 等待打包 SET 作为下一个捆绑包。 下载中：捆绑包正在下载。 成功：捆绑包已下载并准备就绪。

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

SET

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

错误：捆绑包下载失败。

标题：延迟到下一次 继续从功能和设置 to plan dashboard and API operations, connect it with Using @capgo/capacitor-updater 为使用 @capgo/capacitor-updater 的原生能力 API 概述为 API 概述的实现细节介绍为介绍的实现细节 API 密钥为 API 密钥的实现细节, 和设备为设备的实现细节。

功能和设置

Updater Plugin Config

示例

方法

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl(…)

download(…)

next（…）

set(…)

delete(…)

list(…)

重置（…）

当前（）

标题：重载（）

__CAPGO_KEEP_0__

取消延迟()

getLatest(…)

setChannel(…)

unsetChannel(…)

getChannel()

listChannels()

setCustomId(…)

getBuiltinVersion()

getDeviceId()

getPluginVersion()

是否自动更新功能启用？

removeAllListeners()

addListener（‘download’，…）

添加监听器（‘无需更新’，…）

添加监听器（‘updateAvailable’，…）

添加监听器（‘downloadComplete’，…）

addListener（‘majorAvailable’，…）

添加监听器（updateFailed，…）

添加监听器（downloadFailed，…）

addListener（‘appReloaded’，…）

addListener(‘appReady’, …)

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

界面

AppReadyResult

BundleInfo

UpdateUrl

统计URL

频道URL

__CAPGO_KEEP_0__

清单条目

BundleId

BundleListResult

列表选项

ResetOptions

__CAPGO_KEEP_0__

多延迟条件

延迟条件

最新版本

获取最新选项

ChannelRes

SetChannelOptions

清除频道选项

获取频道结果

ListChannelsResult

ChannelInfo

__CAPGO_KEEP_0__

内置版本

设备ID

属性

自动更新

插件监听器句柄

__CAPGO_KEEP_0__

无需事件

UpdateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

DownloadFailedEvent

AppReadyEvent

AutoUpdateAvailable