Cordova 现场更新插件

Cordova插件允许您在不要求用户从应用商店下载新版本的情况下,远程实时更新您的应用,也称为Over-the-Air(OTA)更新.

特征

• ++ 支持 Android 和 iOS 软件
• 与 库克多瓦网络视频 -对 没有 需求 cordova-plugin-ionic-webview
• 📦 套装管理 ——下载、设置和删除捆绑
• ☁️ 云支持 ——通过 云雾
• 📺 频道支持 ——为应用程序设置管理不同版本的频道
• 🔄 自动更新 - 15分钟节流阀的背景更新战略
• 🛟 回滚 ——在失败的更新中自动返回默认捆绑
• 🔁 Delta 更新 — 显示模式下载只更改文件
• ⚙️ 运行时配置 ——运行时更新插件配置
• 📡 更新生命周期事件 ——跟踪下载进度,对捆绑变化作出反应,检测再装入
• 🏷️ 自定义属性 – 通过 Capwesome Cloud 连接自定义密钥值元数据与捆绑
• 🔒 警卫 ——通过RSA签名验证捆绑物的真实性和完整性
• 🌐 开源 麻省理工学院获得执照

通讯

随时更新有关卡帕韦索姆、Capacitor和Ionic生态系统的最新消息和最新消息,因为我们 《卡帕索克通讯》。 。 。 .

兼容性

网络视频兼容性

此插件将服务的文件互换到WebView, 将它连接到 Cordova 的官方插件扩展点(CordovaPluginPathHandler 在安卓上, CDVPluginSchemeHandler (原始内容存档于2018-09-28). On iOS. 这些钩子只有在WebView通过自定义方案加载内容时才会起火,即: 默认 为现代科多瓦语:

• 机器人 (cordova-android ~10):载荷来自 https://localhost/ 通过 WebViewAssetLoader。 。 。 .
• iOS系统 (cordova-ios 7):载荷来自 app://localhost/ 通过 WKURLSchemeHandler。 。 。 .

插件确实如此 没有 如果您的应用程序强制 WebView 返回到遗产中 file:// 计划,例如:

• <preference name="AndroidInsecureFileModeEnabled" value="true" />
• <preference name="Scheme" value="file" />

电离-网络视图

cordova-plugin-ionic-webview 实值 不兼容 使用此插件。 它用自己的本地服务器取代了WebView,它直接服务内容,从不调用上面的扩展点,所以被下载的捆绑被默默地忽略了—— sync() 财务报告和审定财务报表 reload() 似乎成功, 但 WebView 继续显示应用二进制中运出的内容 。 这影响到了Android和iOS.

如果你的应用程序使用 cordova-plugin-ionic-webview,删除:

cordova plugin remove cordova-plugin-ionic-webview

它不再被维护,也不再需要:现代Cordova通过iOS上的WKWebView和Android上的系统WebView服务于WebView,其自定义-cheme行为与这个插件所依赖的相同.

指南

• 启动 Capawesome 云直播更新
• 从Ionic Appflow到 Capawesome 云

安装

通过运行以下命令来安装插件,并遵循下面特定平台的指示:

cordova plugin add @capawesome/cordova-live-update --variable APP_ID=<your-app-id>

机器人

频道

对a 静态 默认频道,使用 DEFAULT_CHANNEL 插件变量——不需要本地配置 .

使用时 版本频道,频道值需要从建筑中插出 versionCode,不能通过插件变量表达。 用克多瓦语 build-extras.gradle 改为机制。 在你的应用 config.xml,添加:

<platform name="android">
    <resource-file src="build-extras.gradle" target="app/build-extras.gradle"/>
</platform>

然后创建 build-extras.gradle 旁边 config.xml数字 :

android {
    applicationVariants.all { variant ->
        variant.resValue "string", "capawesome_live_update_default_channel", "production-${variant.versionCode}"
    }
}

iOS系统

频道

对a 静态 默认频道,使用 DEFAULT_CHANNEL 插件变量——不需要本地配置 .

使用时 版本频道时,使用 Cordova 的 <config-file> 应用程序中的机制 config.xml数字 :

<platform name="ios">
    <config-file target="*-Info.plist" parent="CapawesomeLiveUpdateDefaultChannel">
        <string>production-$(CURRENT_PROJECT_VERSION)</string>
    </config-file>
</platform>

Xcode 解析 $(CURRENT_PROJECT_VERSION) 在建设时间.

隐私表

从开始 索多瓦-欧斯 7.1.0,iOS系统 隐私宣言 通过一个 <privacy-manifest> 元素在 <platform name="ios"> 你应用的一节 config.xml添加一个 NSPrivacyAccessedAPICategoryUserDefaults 此插件的条目 :

<platform name="ios">
    <privacy-manifest>
        <key>NSPrivacyAccessedAPITypes</key>
        <array>
            <!-- Add this dict entry to the array if the key already exists. -->
            <dict>
                <key>NSPrivacyAccessedAPIType</key>
                <string>NSPrivacyAccessedAPICategoryUserDefaults</string>
                <key>NSPrivacyAccessedAPITypeReasons</key>
                <array>
                    <string>CA92.1</string>
                </array>
            </dict>
        </array>
    </privacy-manifest>
</platform>

我们建议宣布 CA92.1 作为获得《公约》 UserDefaults API (英语).

插件变量

这些到克多瓦的地图 <preference> 输入 config.xml。设置为安装时间 --variable,或编辑 config.xml 直接 :

示例

<plugin name="@capawesome/cordova-live-update" spec="0.1.0">
  <variable name="APP_ID" value="6e351b4f-69a7-415e-a057-4567df7ffe94" />
  <variable name="AUTO_UPDATE_STRATEGY" value="background" />
  <variable name="DEFAULT_CHANNEL" value="production" />
  <variable name="READY_TIMEOUT" value="10000" />
  <variable name="PUBLIC_KEY" value="-----BEGIN PUBLIC KEY-----MIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDDodf1SD0OOn6hIlDuKBza0Ed0OqtwyVJwiyjmE9BJaZ7y8ZUfcF+SKmd0l2cDPM45XIg2tAFux5n29uoKyHwSt+6tCi5CJA5Z1/1eZruRRqABLonV77KS3HUtvOgqRLDnKSV89dYZkM++NwmzOPgIF422mvc+VukcVOBfc8/AHQIDAQAB-----END PUBLIC KEY-----" />
</plugin>

演示

这里有一个实例: capawesome-team/cordova-live-update-demo 互联网档案馆的存檔,存档日期2013-12-02

机器人	iOS系统

使用量

插件附着到 cordova.plugins.LiveUpdate 一次 deviceready 火灾.

如果您使用 TypeScript, 类型定义可以从 npm 包中获取 :

import type { LiveUpdatePlugin } from '@capawesome/cordova-live-update';

declare const cordova: { plugins: { LiveUpdate: LiveUpdatePlugin } };

const { LiveUpdate } = cordova.plugins;

const deleteBundle = async () => {
  await LiveUpdate.deleteBundle({ bundleId: 'my-bundle' });
};

const downloadBundle = async () => {
  await LiveUpdate.downloadBundle({ url: 'https://example.com/1.0.0.zip', bundleId: '1.0.0' });
};

const fetchChannels = async () => {
  const result = await LiveUpdate.fetchChannels();
  return result.channels;
};

const fetchLatestBundle = async () => {
  await LiveUpdate.fetchLatestBundle();
};

const getBundles = async () => {
  const result = await LiveUpdate.getBundles();
  return result.bundleIds;
};

const getChannel = async () => {
  const result = await LiveUpdate.getChannel();
  return result.channel;
};

const getCurrentBundle = async () => {
  const result = await LiveUpdate.getCurrentBundle();
  return result.bundleId;
};

const getCustomId = async () => {
  const result = await LiveUpdate.getCustomId();
  return result.customId;
};

const getDeviceId = async () => {
  const result = await LiveUpdate.getDeviceId();
  return result.deviceId;
};

const getNextBundle = async () => {
  const result = await LiveUpdate.getNextBundle();
  return result.bundleId;
};

const getVersionCode = async () => {
  const result = await LiveUpdate.getVersionCode();
  return result.versionCode;
};

const getVersionName = async () => {
  const result = await LiveUpdate.getVersionName();
  return result.versionName;
};

const ready = async () => {
  const result = await LiveUpdate.ready();
  if (result.currentBundleId) {
    console.log(`The app is now using the bundle with the identifier ${result.currentBundleId}.`);
  }
  if (result.previousBundleId) {
    console.log(`The app was using the bundle with the identifier ${result.previousBundleId}.`);
  }
  if (result.rollback) {
    console.log('The app was reset to the default bundle.');
  }
};

const reload = async () => {
  await LiveUpdate.reload();
};

const reset = async () => {
  await LiveUpdate.reset();
};

const setChannel = async () => {
  await LiveUpdate.setChannel({ channel: 'production-5' });
};

const setCustomId = async () => {
  await LiveUpdate.setCustomId({ customId: 'my-custom-id' });
};

const setNextBundle = async () => {
  await LiveUpdate.setNextBundle({ bundleId: '7f0b9bf2-dff6-4be2-bcac-b068cc5ea756' });
};

const sync = async () => {
  const result = await LiveUpdate.sync({
    channel: 'production-5',
  });
  return result.nextBundleId;
};

const isNewBundleAvailable = async () => {
  const { bundleId: latestBundleId } = await LiveUpdate.fetchLatestBundle({
    channel: 'production-5',
  });
  if (latestBundleId) {
    const { bundleId: currentBundleId } = await LiveUpdate.getCurrentBundle();
    return latestBundleId !== currentBundleId;
  } else {
    return false;
  }
};

API 密码

• clearBlockedBundles()
• deleteBundle(...)
• downloadBundle(...)
• fetchChannels(...)
• fetchLatestBundle(...)
• getBlockedBundles()
• getBundles()
• getChannel()
• getConfig()
• getDownloadedBundles()
• getCurrentBundle()
• getCustomId()
• getDeviceId()
• isSyncing()
• getNextBundle()
• getVersionCode()
• getVersionName()
• ready()
• reload()
• reset()
• resetConfig()
• setChannel(...)
• setConfig(...)
• setCustomId(...)
• setNextBundle(...)
• sync(...)
• addListener('downloadBundleProgress', ...)
• addListener('nextBundleSet', ...)
• removeAllListeners()
• 接口
• 类型异名

清除锁定的 Bundles ()

clearBlockedBundles() => any

从被封锁列表中清除所有被封锁的捆绑 .

这将删除所有自动被封存的捆绑标识符 由于回滚 autoBlockRolledBackBundles 已启用.

回返情况: any

自: 0.1.0 (中文(简体) )

删除Bundle(...)

deleteBundle(options: DeleteBundleOptions) => any

从应用程序中删除捆绑 .

回返情况: any

自: 0.1.0 (中文(简体) )

下载Bundle(...)

downloadBundle(options: DownloadBundleOptions) => any

下载一捆.

回返情况: any

自: 0.1.0 (中文(简体) )

获取频道(...)

fetchChannels(options?: FetchChannelsOptions | undefined) => any

获取频道从 云雾。 。 。 .

这主要是为了发展和质量保证的目的. 它允许您获取可用的频道列表,以便您 使用它们之间的动态切换 setChannel(...)。 。 。 .

请注意: 只为公共频道启用的应用程序工作. 如果频道是私有的,仍然可以使用 setChannel(...) 但不会被这个方法返回.

回返情况: any

自: 0.1.0 (中文(简体) )

获取 LatestBundle (...)

fetchLatestBundle(options?: FetchLatestBundleOptions | undefined) => any

使用 云雾。 。 。 .

回返情况: any

自: 0.1.0 (中文(简体) )

获取被锁的邦德莱斯( )

getBlockedBundles() => any

获取所有被封锁的捆绑标识符 .

返回自动被屏蔽的捆绑标识符列表 由于回滚 autoBlockRolledBackBundles 已启用.

回返情况: any

自: 0.1.0 (中文(简体) )

获取 Bundles( )

getBundles() => any

获取所有已下载的捆绑标识符 .

回返情况: any

自: 0.1.0 (中文(简体) )

获取频道( C)

getChannel() => any

获取用于更新的频道 .

频道按以下顺序解决(最优先先解决): 1

1. setChannel() (Android上的共享首选 / iOS上的用户默认)
2. 本地配置( N)CapawesomeLiveUpdateDefaultChannel 内 Info.plist 在iOS上或 capawesome_live_update_default_channel 内 strings.xml (Android号)
3. 这个 DEFAULT_CHANNEL 首选项 config.xml

说明编号: channel 参数 sync() 拥有最高优先级 但并没有坚持下去,因此没有用这种方法返回.

回返情况: any

自: 0.1.0 (中文(简体) )

获取Config ()

getConfig() => any

获取运行时间配置 .

返回包括任何运行时间在内的当前插件配置 通过 setConfig()。 。 。 .

回返情况: any

自: 0.1.0 (中文(简体) )

获得下载 Bundles( )

getDownloadedBundles() => any

获取所有已下载的捆绑标识符 .

回返情况: any

自: 0.1.0 (中文(简体) )

获取当前Bundle ()

getCurrentBundle() => any

获取当前捆绑的捆绑标识符 . 当前捆绑是应用程序目前使用的捆绑.

回返情况: any

自: 0.1.0 (中文(简体) )

获取 CustomId ()

getCustomId() => any

获取设备的自定义标识符 .

回返情况: any

自: 0.1.0 (中文(简体) )

获取DeviceId ()

getDeviceId() => any

获取唯一设备标识符 .

回返情况: any

自: 0.1.0 (中文(简体) )

正在同步 ()

isSyncing() => any

检查同步操作是否正在进行中 .

回返情况: any

自: 0.1.0 (中文(简体) )

获取 NextBundle ()

getNextBundle() => any

获取下一捆的捆绑标识符 . 下一个捆绑是调用后使用的捆绑 reload() 或重新启动应用程序.

回返情况: any

自: 0.1.0 (中文(简体) )

获取VersionCode ()

getVersionCode() => any

获取应用程序的版本代码.

打开 机器人,这是 versionCode 从 PackageInfo。 。 。 . 打开 iOS系统,这是 CFBundleVersion 从 Info.plist 文档.

回返情况: any

自: 0.1.0 (中文(简体) )

获取VersionName ()

getVersionName() => any

获取应用程序的版本名 .

打开 机器人,这是 versionName 从 PackageInfo。 。 。 . 打开 iOS系统,这是 CFBundleShortVersionString 从 Info.plist 文档.

回返情况: any

自: 0.1.0 (中文(简体) )

准备中( )

ready() => any

通知应用程序已准备好使用的插件, 不需要回滚 .

请注意: 当应用程序准备好使用时, 此方法应该立即调用 防止应用程序被重置到默认捆绑中.

回返情况: any

自: 0.1.0 (中文(简体) )

重新装入( c)

reload() => any

重新装入应用新捆绑的应用程序 .

回返情况: any

自: 0.1.0 (中文(简体) )

重设( c)

reset() => any

将应用程序重置为默认捆绑 .

打电话 reload() 或重新启动应用更改的应用程序.

回返情况: any

自: 0.1.0 (中文(简体) )

重新设置Config ()

resetConfig() => any

将运行时配置重置为从 config.xml。 。 。 .

这将清除任何运行时配置设置通过 setConfig()。 。 。 . 变化立即生效.

回返情况: any

自: 0.1.0 (中文(简体) )

设置频道(...)

setChannel(options: SetChannelOptions) => any

设置用于更新的频道 .

回返情况: any

自: 0.1.0 (中文(简体) )

设置 Config (...)

setConfig(options: SetConfigOptions) => any

设置运行时间配置 .

这样可以在运行时更新插件配置选项 . 这些变化在应用程序重启后一直持续,并立即生效.

重要内容: 运行时配置自动重置为默认值 当本地应用程序更新到新版本时。 这确保 之前版本的配置在应用程序更新后不会持续.

回返情况: any

自: 0.1.0 (中文(简体) )

设置 CustomId (...)

setCustomId(options: SetCustomIdOptions) => any

设置设备的自定义标识符 .

回返情况: any

自: 0.1.0 (中文(简体) )

设置下一步Bundle(...)

setNextBundle(options: SetNextBundleOptions) => any

设定用于应用程序的下一个捆绑 .

打电话 reload() 或重新启动应用更改的应用程序.

回返情况: any

自: 0.1.0 (中文(简体) )

同步(...)

sync(options?: SyncOptions | undefined) => any

自动下载并设定应用程序的最新捆绑 云雾。 。 。 .

打电话 reload() 或重新启动应用更改的应用程序.

回返情况: any

自: 0.1.0 (中文(简体) )

添加收听器( “ 下载缓冲进度 ” ,...)

addListener(eventName: 'downloadBundleProgress', listenerFunc: DownloadBundleProgressListener) => any

听一个捆绑的下载进度.

回返情况: any

自: 0.1.0 (中文(简体) )

添加倾听器( 下一个BundleSet, ...)

addListener(eventName: 'nextBundleSet', listenerFunc: NextBundleSetListener) => any

听好了,当一个捆绑被设定为下一个捆绑时.

当下个应用程序重新启动时使用捆绑时,此事件会被触发, 通过自动更新或人工呼叫 setNextBundle()。 。 。 .

回返情况: any

自: 0.1.0 (中文(简体) )

删除所有收听器( )

removeAllListeners() => any

删除此插件的所有听众 .

回返情况: any

自: 0.1.0 (中文(简体) )

接口

删除边框选项

下载边框选项

获取频道选项

获取频道结果

频道

获取 LastBundle 选项

获取 LatestBundle 成果

打开Blockbundles 后台

获取邦德莱斯结果

获取频道结果

获取压缩结果

下载Bundles Result 中

获取当前缓冲

获取 CustomId 结果

获取DeviceId 成果

正在同步结果

获取旁边的废墟

获取VersionCode结果

获取版本Name

准备完毕

设置频道选项

设置配置选项

设置自定义Id 选项

设置下一个选项

同步选项

同步结果

下载缓冲进程

当捆绑更改的下载进度时触发的事件 .

插件听筒

处理从 addListener(...)调用 remove() 拆卸 听着.

下一个BundleSet Event

当捆绑被设定为下一个捆绑时触发的事件 .

类型异名

下载缓冲进程倾听器

一个捆绑的下载进度的监听器 .

(event: DownloadBundleProgressEvent): void

下一个BundleSet收听器

当一个捆绑被设定为下一个捆绑时的监听者.

(event: NextBundleSetEvent): void

更改日志

见 变动情况。 。 。 .

许可证

见 自由主义。 。 。 .