超级群快速上手
本教程是为了让新手快速了解融云即时通讯能力库(IMLib)。在本教程中,你可以体验集成 SDK 的基本流程和 IMLib 的超级群通信能力。
融云开发者账户
融云开发者账户是使用融云 SDK 产品的必要条件。在开始之前,请先前往融云官网注册开发者账户。注册后,控制台将自动为你创建一个应用,默认为开发环境应用,使用国内数据中心。请获取该应用的 App Key,在本教程中使用。
提示
App Secret 用于生成数据签名,仅在请求融云服务端 API 接口时使用。本教程中暂不涉及。
如果您已拥有融云开发者账户,你可以直接选择合适的环境,创建应用。
您需要记录上图所示的应用 App Key,在本教程中使用。
应用的 AppKey 与 Secret 是获取连接融云服务器身份凭证的必要条件,请注意不要泄露。
导入 SDK
提示
IMLib 对 Typescript 的使用者提供了友好的类型化支持,推荐开发者使用 Typescript 进行业务开发以提升代码健壮性及可维护性。
依赖安装
npm install @rongcloud/engine -S
npm install @rongcloud/imlib-next -S
代码集成
// 非 ESModule
const RongIMLib = require('@rongcloud/imlib-next')
// ESModule
import * as RongIMLib from '@rongcloud/imlib-next'
App Key
App Key 是使用 IMLib 进行即时通讯功能开发的必要条件,也是应用的唯一性标识。在集成使用 IMLib 之前,请务必先通过控制台注册并获取开发者的专属 App Key。
只有在 App Key 相同的情况下,不同用户之间的消息才能互通。
初始化
在使用 IMLib 的能力之前,必须先调用 IMLib 的初始化接口,且务必保证该接口在应用全生命周期内仅被调用一次。
// 应用初始化以获取 RongIMLib 实例对象,请务必保证此过程只被执行一次
RongIMLib.init({ appkey: '<Your-App-Key>' })
设置监听
初始化完成后,添加事件监听器,及时获取相关事件通知。IM 在初次连接成功后,需立即同步消息,获取全量超级群会话列表,列表同步完成前,所有超级群 相关功能接口不可用
// 添加事件监听
const Events = RongIMLib.Events
RongIMLib.addEventListener(Events.CONNECTING, () => {
console.log('正在连接服务器')
})
RongIMLib.addEventListener(Events.CONNECTED, () => {
console.log('已经连接到服务器')
})
RongIMLib.addEventListener(Events.MESSAGES, (evt) => {
console.log(evt.messages)
})
// 会话列表同步完成,可通过监听 Events.ULTRA_GROUP_ENABLE 事件以通知业务层会话列表同步完成
RongIMLib.addEventListener(Events.ULTRA_GROUP_ENABLE, (conversationList) => {
console.log(conversationList)
})
// 会话状态变动监听 包含:会话未读数、@ 未读数、免打扰状态
RongIMLib.addEventListener(Events.CONVERSATION, ({ conversationList }) => {
console.log(conversationList)
})