跳过内容

@capgo/capacitor-live-activities

Capacitor iOS 活动管理插件接口

Capacitor Live Activities Plugin interface for managing iOS Live Activities.

Section titled “Core Capabilities”

__CAPGO_KEEP_0__ iOS 活动管理插件接口
  • areActivitiesSupported - 检查该设备是否支持实时活动。需要 iOS 16.1+ 和设备支持。
  • startActivity - 使用指定的布局和数据开始一个新的实时活动。
  • updateActivity - 使用新数据更新一个现有的实时活动。
  • endActivity - 结束一个实时活动。
方法描述
areActivitiesSupported检查该设备是否支持实时活动。需要 iOS 16.1+ 和设备支持。
startActivity使用指定的布局和数据开始一个新的实时活动。
updateActivity使用新数据更新一个现有的实时活动。
endActivity结束一个实时活动。
getAllActivities获取当前所有活跃的实时活动。
saveImage将图片保存到共享的 App Group 容器中,以便在实时活动中使用。图片必须保存到共享容器才能从小部件扩展中访问。
removeImage从共享容器中删除已保存的图片。
listImages列出共享容器中的所有已保存的图片。
cleanupImages从共享容器中删除所有已保存的图片。
getPluginVersion获取本机 Capacitor 插件版本。
startTimerSequence启动运动/运动的计时器序列。iOS 中显示在实时活动中,动态岛上。Android 中显示为前台通知。
pauseTimerSequence暂停计时器序列。
resumeTimerSequence恢复暂停的计时器序列。
stopTimerSequence停止并dismiss计时器序列。
skipTimerStep跳过计时器序列中的下一步。
previousTimerStep返回计时器序列中的上一步。
getTimerState获取当前计时器序列的状态。
addListener添加计时器序列事件的监听器。事件包括:步骤改变,完成,计时,暂停,恢复,停止,循环完成。

此参考资料是从 src/definitions.tscapacitor-live-activities.