跳转到正文

@capgo/capacitor-app-intents

从 Capacitor 发布 Siri 短语、快捷指令、Spotlight、主屏幕快速操作和实体目录,并配备冷启动安全的调用队列。

@capgo/capacitor-app-intents 将 Apple App Intents 连接到您的 Capacitor JavaScript 层:在冷启动时排空待处理队列、为 Shortcuts 参数发布实体目录、为 Spotlight 内容建立索引、设置主屏幕快速操作,并监听 appIntentInvoked 事件。Siri 快捷指令 短语 是生成的 Swift 代码中的编译期字面量,而非运行时字符串。

将此插件与 Siri、快捷指令与小组件 配合使用,当您同时使用 Widget Kit、Live Activities、Share Target 或 Intent Launcher 时。

平台支持备注
iOS是iOS 16 及更高版本
Android否方法会 reject 并给出明确的错误
Web 端否使用 Capacitor.getPlatform() 做保护
  • getPendingInvocations - 返回在 JavaScript 就绪前已排队的调用。
  • removePendingInvocation - 在你的 handler 处理完后,移除一个待处理的调用。
  • setEntityCatalog - 为给定的类型字符串持久化实体目录。
  • setHomeScreenShortcutItems - 替换主屏幕快速操作(UIApplicationShortcutItems)。
方法描述
getPendingInvocations返回在 JavaScript 就绪前已排队的调用。
removePendingInvocation在 handler 处理完后,移除一个待处理的调用。
setEntityCatalog为给定的类型字符串持久化实体目录。
setHomeScreenShortcutItems替换主屏幕快速操作 (UIApplicationShortcutItems)。
indexSpotlightEntities为你的 App 域建立 Spotlight 条目索引。
removeSpotlightEntities按 id 删除 Spotlight 项。
performAppleSchemaTemplate将 JavaScript 处理程序加入队列,用于 alpha 版 Apple schema template。
addListener监听 appIntentInvoked 当有新的调用入队时。
removeAllListeners移除该插件的所有监听器。
getPluginVersion原生插件版本字符串。

此参考文档同步自 src/definitions.ts 中的 capacitor-app-intents.