使用 @capgo/capacitor-intercom
Intercom Capacitor 插件。
安装
bun add @capgo/capacitor-intercom
bunx cap sync
bunx cap sync 将插件的原生 code 复制到你的原生项目中。每次升级插件后都要重新运行。
导入
import { CapgoIntercom } from '@capgo/capacitor-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 |
设置用于安全消息认证的 JWT。 |
setBottomPadding |
设置 Intercom 聊天窗口底部的内边距。 |
sendPushTokenToIntercom |
向 Intercom 发送推送通知 token。 |
receivePush |
处理收到的 Intercom 推送通知。 |
getUnreadConversationCount |
获取当前用户的未读会话数。 |
示例
loadWithKeys()
在运行时使用 API 密钥初始化 Intercom。如果你不想在 capacitor.config 中配置密钥，可以用这种方式。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.loadWithKeys({
appId: 'app-id-123',
apiKeyIOS: 'api-key-ios',
apiKeyAndroid: 'api-key-android',
});
registerIdentifiedUser()
在 Intercom 中注册已知用户。至少需要提供 userId 或 email 之一。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerIdentifiedUser({
userId: 'user-id-123',
email: 'user@example.com',
});
registerUnidentifiedUser()
在 Intercom 中注册匿名用户。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.registerUnidentifiedUser();
updateUser()
更新 Intercom 中的用户属性。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.updateUser({ userId: 'user-id-123' });
logout()
让用户退出 Intercom 登录。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logout();
logEvent()
在 Intercom 中记录自定义事件。
import { CapgoIntercom } from '@capgo/capacitor-intercom';
await CapgoIntercom.logEvent({ name: 'example' });
上表列出了 23 个核心方法。监听器与版本辅助函数，以及每个方法的完整契约，均记录在 GitHub 仓库.
监听事件
addListener 会返回一个句柄。调用 handle.remove() 在屏幕卸载时，或者调用 CapgoIntercom.removeAllListeners() 以清除所有监听器。
完整参考文档
继续使用 @capgo/capacitor-intercom
如果你正在使用 使用 @capgo/capacitor-intercom 要规划原生插件工作，请将其与 @capgo/capacitor-intercom 有关 @capgo/capacitor-intercom 的实现细节， 快速入门 有关“入门指南”中的实现细节， Capgo 插件目录 查看 Capgo 插件目录中的产品工作流， Capgo 提供的 Capacitor 插件 有关 Capgo 开发的 Capacitor 插件的实现细节，以及 添加或更新插件 有关添加或更新插件的实现细节。