简介
简介Capacitor iOS 活动实时更新插件接口,用于管理 iOS 活动实时更新。
核心功能
核心功能areActivitiesSupported- 检查是否支持此设备的活动实时更新。需要 iOS 16.1+ 和设备支持。startActivity- 使用指定的布局和数据启动一个新的活动实时更新。updateActivity- 使用新数据更新一个现有的活动实时更新。endActivity- 结束一个活动实时更新。
公共 API
公共 API| 方法 | 功能描述 |
|---|---|
areActivitiesSupported | 检查该设备是否支持实时活动。需要 iOS 16.1+ 和设备支持。 |
startActivity | 使用指定的布局和数据启动一个新的实时活动。 |
updateActivity | 更新一个现有的实时活动的数据。 |
endActivity | 结束一个实时活动。 |
getAllActivities | 获取当前所有活跃的实时活动。 |
saveImage | 将一个图片保存到共享的 App Group 容器中,以便在实时活动中使用。图片必须保存到共享容器中才能在小部件扩展中访问。 |
removeImage | 从共享容器中删除一个保存的图片。 |
listImages | 列出共享容器中的所有保存的图片。 |
cleanupImages | 从共享容器中删除所有保存的图片。 |
getPluginVersion | 获取本地 Capacitor 插件的版本号。 |
startTimerSequence | 启动一个计时器序列,用于运动/运动。iOS 上显示在实时活动中,动态岛上显示。Android 上显示为前台通知,计时器显示。 |
pauseTimerSequence | 暂停计时序列。 |
resumeTimerSequence | 恢复暂停的计时序列。 |
stopTimerSequence | 停止并关闭计时序列。 |
skipTimerStep | 跳过序列中的下一步。 |
previousTimerStep | 返回序列中的上一步。 |
getTimerState | 获取计时序列的当前状态。 |
addListener | 为计时序列事件添加监听器。事件包括:步骤改变,完成,计时,暂停,恢复,停止,循环完成。 |
真实来源
标题为“真实来源”的部分此参考资料是从 src/definitions.ts 在 capacitor-live-activities.