IM聊天室服务-im-jssdk FunctionCode | SER-B006
im-jssdk用于帮助开发者快速集成IM聊天室服务
快速上手
您可以通过以下命令安装SDK
bash
npm install @lkcloud/im-jssdk引入
在 main.js 中加入以下内容：
javascript
import wsToolsUtil from '@lkcloud/im-jssdk'
Vue.prototype.$wsToolsUtil = wsToolsUtilAPI文档
连接聊天服务
参数
- url: 连接聊天服务的地址
- token: 认证令牌
- cb: 回调函数
javascript
$wsToolsUtil.signalrStart(url, token, cb)加入房间
参数
- conversationId: 会话唯一id
- userId: 用户id
- userSig: 用户签名
javascript
params = {conversationId:'',userId:'',userSig:''}
$wsToolsUtil.joinChat(params)注意
需在连接聊天服务(signalrStart)的回调函数中使用。
心跳包
每10秒调用1次
参数
- conversationId: 会话唯一id
- userId: 用户id
- userSig: 用户签名
javascript
params = {conversationId:'',userId:'',userSig:''}
$wsToolsUtil.heartbeat(params)注意
需在连接聊天服务(signalrStart)的回调函数中使用。
开启接收新消息监听
使用以下方法开启接收新消息的监听：
javascript
$wsToolsUtil.receiveMessage(cb)参数
- cb: 回调函数
使用举例
javascript
$wsToolsUtil.receiveMessage((res) => {
console.log(res);
});注意
需在连接聊天服务(signalrStart)的回调函数中使用。
发送消息
参数
| 名称 | 描述 | 类型 | 必填 |
|---|---|---|---|
| senderId | 发送者 ID | string | 是 |
| recipientId | 接收者 ID | string | 否 |
| conversationId | 会话 ID | string | 是 |
| type | 消息类型（0：文本，1：图片） | int | 是 |
| content | 消息内容（文本消息或图片 ID） | string | 是 |
| userId | 用户Id | string | 是 |
| userSig | 用户签名 | string | 是 |
javascript
params = {conversationId:'',userId:'',userSig:''}
$wsToolsUtil.sendMessage(params)