Functions and settings

Updater插件配置

查看Github README for more information.

CapacitorUpdater可以配置以下选项：

属性	类型	描述	默认值	自
`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’`	配置插件如何通过更新服务器使用自动更新。true与“atBackground”相同，false与“off”相同。- off：禁用自动更新- atBackground：在应用程序切换到后台时自动检查和下载，然后在应用程序切换到后台时应用- atInstall：仅在新安装或原生应用程序更新后立即应用，否则使用atBackground- onLaunch：在启动时立即应用，否则在启动检查后使用atBackground- always：在自动更新运行时立即应用- onlyDownload：自动检查和下载，然后在应用程序切换到后台时立即应用。可用于Android、iOS和Electron。	`”atBackground” // true is still accepted`
`resetWhenUpdate`	`boolean`	自动删除之前下载的捆绑包，当设备上安装了新版本的本机应用程序包时。可用于Android、iOS和Electron。	`true`
`updateUrl`	`string`	配置更新检查发送到的URL/端点。可用于Android、iOS和Electron。	`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”模式代替：autoUpdate。该选项仍然支持现有应用程序。- 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直接更新值。需要安装并配置@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`	配置CLI使用本地api进行测试。	`undefined`	6.3.3
`localApiFiles`	`string`	配置CLI使用本地文件api进行测试。	`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，这将用于设置通道。

参数	类型	描述
`options`	`ChannelUrl`	包含用于设置通道的 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 捆绑包信息.id}

返回值 Promise<BundleInfo>

set(…)

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

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

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

delete(…)

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

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

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

名为“list(…)

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

Param

Type	描述	一个 {@link}
`options`	`ListOptions`	__CAPGO_KEEP_0__ 列表选项__CAPGO_KEEP_0__

返回值: Promise<BundleListResult>

reset(…)

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

重置应用到 builtin 应用程序包（发送到 Apple App Store / Google Play Store）或最后成功加载的包。

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

current()

current() => Promise<CurrentBundleResult>

获取当前包，如果没有设置则返回 builtin. currentNative 是设备上安装的原始包

返回： Promise<CurrentBundleResult>

reload()

reload() => Promise<void>

重新加载视图

setMultiDelay(…)

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

设置一个 {@link DelayCondition} 数组，包含插件将使用的延迟更新条件。当所有条件都满足后，更新过程将重新启动，更新将在后台或杀死应用后安装。对于 "kind"，值应为 ISO8601 日期字符串。对于 "kind"，值应为毫秒数。对于 "kind"，值应为版本号。对于 "kind"，值不被使用。该函数在选项 kill 时会触发不一致的行为，会在第一次杀死应用后触发更新，而不是在下一次后台运行时。将在未来的重大版本中修复。 ParamDelayCondition date kind background kind nativeVersion kind kill kind

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

Since: 4.3.0

取消延迟()

cancelDelay() => Promise<void>

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

自从： 4.0.0

getLatest(…)

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

从更新URL获取最新的捆绑包

参数	类型
`options`	`GetLatestOptions`

返回： Promise<LatestVersion>

自从： 4.0.0

setChannel(…)

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

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

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.
公共频道不能自行分配。
如果频道标记为 , 调用 public会返回错误。要使用公共频道，请调用 setChannel() - 设备将自动切换到匹配的公共频道。 unsetChannel() __CAPGO_KEEP_0__
使用 listChannels() 来发现哪些频道可用并且是否允许自赋值。

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

返回: Promise<ChannelRes>

自从: 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(), 删除设备的频道分配，设备将自动从公共频道接收更新。
allow_self_set: 如果 true, 这是一个 自分配频道。您可以使用 setChannel().

explicitly 将设备分配到此频道。 Promise<ListChannelsResult>

Returns: 7.5.0

Since:

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

在应用程序中监听重大更新事件，让您知道重大更新是否被禁用AutoUpdateBreaking设置

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

返回值： Promise<PluginListenerHandle>

自： 2.3.0

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

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

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

参数	类型
`eventName`	`’updateFailed’`
`listenerFunc`	`(state: UpdateFailedEvent) => void`

返回值： Promise<PluginListenerHandle>

自： 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>

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

更新地址

属性	类型
`url`	`string`

统计URL

属性	类型
`url`	`string`

频道URL

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

__CAPGO_KEEP_0__

This URL and versions are used to download the bundle from the server, If you use backend all information will be given by the method getLatest. If you don’t use backend, you need to provide the URL and version of the bundle. SessionKey are required if you encrypted the bundle with the CLI command encrypt, you should receive them as result of the command.

属性	类型	描述	默认值	自
`url`	`string`	更新包的 zip 文件 URL (例如：dist.zip)，用于下载。 (此 URL 可以是任何 URL。例如：Amazon S3，一个 GitHub 标签，任何其他地方你托管的包。)
`version`	`string`	更新包的版本 code/名称
`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

类型	BundleListResult
`bundles`	`BundleInfo[]`

属性、类型、ListOptions

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

ResetOptions

类型	当前包结果
`toLastSuccessful`	`boolean`

自

属性	类型
`bundle`	`BundleInfo`
`native`	`string`

多延迟条件

属性	类型
`delayConditions`	`DelayCondition[]`

延迟条件

类型	描述	__CAPGO_KEEP_0__
`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

Prop	Type
`channel`	`string`
`triggerAutoUpdate`	`boolean`

取消频道选项

Prop	Type
`triggerAutoUpdate`	`boolean`

获取频道结果

Prop	Type	描述	自
`channel`	`string`	获取频道的当前状态	4.8.0
`error`	`string`
`message`	`string`
`status`	`string`
`allowSet`	`boolean`

ListChannelsResult

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

ChannelInfo

Prop	类型	描述	__CAPGO_KEEP_0__
`id`	`number`	The numeric channel 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

SetCustomIdOptions name自 id.

自

属性	类型
`customId`	`string`

内置版本

属性	类型
`version`	`string`

设备ID

类型	插件版本
`deviceId`	`string`

属性

属性	类型
`version`	`string`

自动更新

属性	类型
`enabled`	`boolean`

插件监听器句柄

类型	下载事件
`remove`	`() => Promise<void>`

属性

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

无需事件

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

UpdateAvailableEvent

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

DownloadCompleteEvent

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

MajorAvailableEvent

Prop	Type	描述	自
`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: 等待打包 设置为下一个捆绑包。 downloading: 捆绑包正在下载中。 success: 捆绑包下载完成，准备就绪。 设置为下一个捆绑包。 error: 捆绑包下载失败。 延迟到下一个 Section titled “延迟到下一个”

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

从函数和设置继续

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

如果您正在使用

来规划仪表板和 __CAPGO_KEEP_0__ 操作，连接它与 使用 @__CAPGO_KEEP_0__/__CAPGO_KEEP_1__-updater 使用 @API/__CAPGO_KEEP_1__-updater 使用 @capgo/capacitor-updater 为使用 @capgo/capacitor-updater 的原生能力 API 概述为 API 概述的实现细节介绍为介绍的实现细节 API 密钥为 API 密钥的实现细节设备为设备的实现细节

Functions and settings

Updater插件配置

示例

方法

notifyAppReady()

setUpdateUrl(…)

setStatsUrl(…)

setChannelUrl（…）

download（…）

next（…）

set(…)

delete(…)

名为“list(…)

reset(…)

current()

reload()

setMultiDelay(…)

取消延迟()

getLatest(…)

setChannel(…)

unsetChannel(…)

标题“getChannel()”

listChannels()

Since:

getBuiltinVersion()

getDeviceId()

getPluginVersion()

是否自动更新

removeAllListeners()

添加下载事件监听器（…）

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

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

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

addListener（‘majorAvailable’，…）

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

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

addListener（‘appReloaded’，…）

addListener(‘appReady’, …)

isAutoUpdateAvailable()

getNextBundle()

setShakeMenu(…)

isShakeMenuEnabled()

接口

AppReadyResult

BundleInfo

更新地址

统计URL

频道URL

__CAPGO_KEEP_0__

清单项

BundleId

BundleListResult

属性、类型、ListOptions

ResetOptions

自

多延迟条件

延迟条件

最新版本

获取最新选项

ChannelRes

SetChannelOptions

取消频道选项

获取频道结果

ListChannelsResult

ChannelInfo

自

内置版本

设备ID

属性

自动更新

插件监听器句柄

属性

无需事件

UpdateAvailableEvent

DownloadCompleteEvent

MajorAvailableEvent

UpdateFailedEvent

DownloadFailedEvent

AppReadyEvent

AutoUpdateAvailable