@capgo/capacitor-intercom

概览

@capgo/capacitor-intercom 封装官方 Intercom 移动端 SDK，让客服、onboarding 和生命周期营销活动保持原生，同时让你的 app shell 保持 Capacitor。可通过 JavaScript 识别用户、打开 Messenger、记录事件并展示帮助中心内容。

平台支持

平台	支持
iOS	Intercom iOS SDK
Android	Intercom Android SDK
Web 端	暂不支持

核心功能

• loadWithKeys - 在运行时使用 API 密钥初始化 Intercom。如果您不想在 capacitor.config 中配置密钥，请使用此方法。
• registerIdentifiedUser - 在 Intercom 中注册已知用户。必须提供 userId 或 email 中的至少一个。
• registerUnidentifiedUser - 在 Intercom 中注册匿名用户。
• updateUser - 更新 Intercom 中的用户属性。

公开 API

方法	描述
loadWithKeys	在运行时使用 API 密钥初始化 Intercom。如果你不想在 capacitor.config 中配置密钥，可以用这种方式。
registerIdentifiedUser	在 Intercom 中注册已知用户。至少需要提供 userId 或 email 之一。
registerUnidentifiedUser	在 Intercom 中注册匿名用户。
updateUser	更新 Intercom 中的用户属性。
logout	让用户退出 Intercom 登录。
logEvent	在 Intercom 中记录自定义事件。
displayMessenger	打开 Intercom 消息窗口。
displayMessageComposer	打开消息编辑器，并预填消息内容。
displayHelpCenter	打开 Intercom 帮助中心。
hideMessenger	隐藏 Intercom 消息窗口。
displayLauncher	显示 Intercom 启动按钮。
hideLauncher	隐藏 Intercom 启动按钮。
displayInAppMessages	启用来自 Intercom 的应用内消息。
hideInAppMessages	禁用来自 Intercom 的应用内消息。
displayCarousel	显示特定的 Intercom 轮播。
displayArticle	显示特定的 Intercom 文章。
displaySurvey	显示特定的 Intercom 调查。
setUserHash	设置用于身份验证的 HMAC。
setUserJwt	设置用于安全 Messenger 身份验证的 JWT。
setBottomPadding	设置 Intercom Messenger UI 的底部内边距。
sendPushTokenToIntercom	向 Intercom 发送推送通知 token。
receivePush	处理收到的 Intercom 推送通知。
getUnreadConversationCount	获取当前用户的未读会话数。
addListener	监听 Intercom 窗口显示事件。
addListener	监听 Intercom 窗口隐藏事件。
addListener	监听未读对话数量的变化。
removeAllListeners	移除所有事件监听器。

单一事实来源

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

继续了解 @capgo/capacitor-intercom

如果你正在使用 @capgo/capacitor-intercom 要规划原生插件工作，请将其与 使用 @capgo/capacitor-intercom 用于“使用 @capgo/capacitor-intercom”中的原生能力， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 查看由 Capgo 提供的 Capacitor 插件中的实现细节， 添加或更新插件 关于“添加或更新插件”中的实现细节，以及 Ionic Enterprise 插件替代方案 关于“Ionic Enterprise 插件替代方案”中的产品工作流。