概览
“概览”章节@capgo/capacitor-live-activities 管理 ActivityKit 通过 JSON 布局 DSL 实现来自 Capacitor 的 Live Activities（包括锁屏、Dynamic Island、计时器、以及在共享 App Group 中的图片）。它并不实现 Apple 的 App Intents、Siri 指令、Shortcuts 应用、Spotlight 索引或待处理的 App Intent 队列。
对于小组件主屏幕界面、SVG 模板或 LiveActivityIntent 与模板事件日志绑定的按钮，请使用 @capgo/capacitor-widget-kit 或配合此插件使用。若需在 JavaScript 中实现 Siri 指令、Spotlight 以及待处理的 App Intent 队列，请使用 @capgo/capacitor-app-intents.
查看 Siri、快捷指令与小组件 Capgo 插件如何映射到系统集成功能。
从这里开始 areActivitiesSupported() 以及下方列出的其他核心方法。
平台支持
标题为“平台支持”的部分| 平台 | 支持 | 备注 |
|---|---|---|
| iOS | 是 | 原生 |
| Android | 是 | 原生 |
| Web 端 | 否 | 使用 Capacitor.getPlatform() 做保护 |
核心功能
标题为“核心功能”的章节areActivitiesSupported- 检查此设备是否支持 Live Activities。需要 iOS 16.1+ 及设备支持。startActivity- 使用指定的布局和数据启动新的 Live Activity。updateActivity- 使用新数据更新现有的 Live Activity。endActivity- 结束 Live Activity。
公开 API
标题为“公开 API”的章节| 方法 | 描述 |
|---|---|
areActivitiesSupported | 检查此设备是否支持 Live Activities。需要 iOS 16.1+ 及设备支持。 |
startActivity | 使用指定的布局和数据启动新的 Live Activity。 |
updateActivity | 使用新数据更新现有的 Live Activity。 |
endActivity | 结束 Live Activity。 |
getAllActivities | 获取所有当前活跃的 Live Activities。 |
saveImage | 将图片保存到共享 App Group 容器，供 Live Activities 使用。图片必须保存到共享容器，widget extension 才能访问。 |
removeImage | 从共享容器中移除已保存的图片。 |
listImages | 列出共享容器中所有已保存的图片。 |
cleanupImages | 从共享容器中移除所有已保存的图片。 |
getPluginVersion | 获取原生 Capacitor 插件版本。 |
startTimerSequence | 为健身/运动启动计时器序列。iOS：在 Live Activity 和 Dynamic Island 中显示；Android：显示为带计时器的前台通知。 |
pauseTimerSequence | 暂停计时器序列。 |
resumeTimerSequence | 恢复已暂停的计时器序列。 |
stopTimerSequence | 停止并关闭计时器序列。 |
skipTimerStep | 跳到序列中的下一步。 |
previousTimerStep | 返回序列中的上一步。 |
getTimerState | 获取计时器序列的当前状态。 |
addListener | 为计时器序列事件添加监听器。事件包括：stepChange、complete、tick、paused、resumed、stopped、loopComplete。 |
单一事实来源
标题为“单一事实来源”的部分此参考文档同步自 src/definitions.ts 中的 capacitor-live-activities.
继续阅读 @capgo/capacitor-live-activities
标题为“继续阅读 @capgo/capacitor-live-activities”的部分如果你正在使用 @capgo/capacitor-live-activities 来规划原生媒体和界面行为，并将其与 使用 @capgo/capacitor-live-activities 用于使用 @capgo/capacitor-live-activities 时的原生能力， 使用 @capgo/capacitor-video-player 用于使用 @capgo/capacitor-video-player 时的原生能力， @capgo/capacitor-video-player 有关 @capgo/capacitor-video-player 的实现细节， 使用 @capgo/capacitor-native-navigation 关于《使用 @capgo/capacitor-native-navigation》中的原生能力，以及 @capgo/capacitor-native-navigation 关于 @capgo/capacitor-native-navigation. 中的实现细节
