Interface OpenIMClient

IM client interface

interface OpenIMClient {
    GetRoleByUserId(rid, uid): IMResponse;
    createRoom(rid): IMResponse;
    deleteRole(uid, rid): string;
    deleteRoom(rid): string;
    deleteRoomHistory(uuid, rid): string;
    getRole(rid): IMResponse;
    getRoomCount(rid): IMResponse;
    getRoomHistory(rid): IMResponse;
    getRoomMember(rid, offset, limit): IMResponse;
    pushRoom(rid, flag, msg): IMResponse;
    pushUser(uid, msg): IMResponse;
    restrictRoom(rid, uid, restrict): IMResponse;
    setRole(uid, rid, role): IMResponse;
}

Index

Methods

GetRoleByUserId createRoom deleteRole deleteRoom deleteRoomHistory getRole getRoomCount getRoomHistory getRoomMember pushRoom pushUser restrictRoom setRole

Methods

GetRoleByUserId

GetRoleByUserId(rid, uid): IMResponse
根据userId查角色信息
Parameters
- rid: string
  房间id
- uid: string
  用户id
Returns IMResponse

createRoom

createRoom(rid): IMResponse
创建房间
Parameters
- rid: string
  房间id
Returns IMResponse

deleteRole

deleteRole(uid, rid): string
删除角色
Parameters
- uid: string
  用户ID
- rid: string
  房间id
Returns string
uid

deleteRoom

deleteRoom(rid): string
删除房间
Parameters
- rid: string
  房间id
Returns string

deleteRoomHistory

deleteRoomHistory(uuid, rid): string
删除历史聊天记录
Parameters
- uuid: string
  消息记录的uuid, 可查询获取
- rid: string
  房间id
Returns string

getRole

getRole(rid): IMResponse
查所有角色信息
Parameters
- rid: string
  房间id
Returns IMResponse

getRoomCount

getRoomCount(rid): IMResponse
查询房间人数
Parameters
- rid: string
  房间id
Returns IMResponse
人数信息

getRoomHistory

getRoomHistory(rid): IMResponse
查询历史聊天记录
Parameters
- rid: string
  房间id
Returns IMResponse
历史聊天记录

getRoomMember

getRoomMember(rid, offset, limit): IMResponse
查询房间人员
Parameters
- rid: string
  房间id
- offset: number
  起始位
- limit: number
  限制数
Returns IMResponse
房间人员信息

pushRoom

pushRoom(rid, flag, msg): IMResponse
发送消息
Parameters
- rid: string
  房间id
- flag: string
  "s"或"S时发送信令操作 "m", "M"时广播到房间消息操作
- msg: string
  消息内容
Returns IMResponse

pushUser

pushUser(uid, msg): IMResponse
发布订阅消息
Parameters
- uid: string
  接收消息的user
- msg: string
  消息内容
Returns IMResponse

restrictRoom

restrictRoom(rid, uid, restrict): IMResponse
禁言
Parameters
- rid: string
  房间id
- uid: string
  用户ID
- restrict: boolean
  禁言标识
Returns IMResponse

setRole

setRole(uid, rid, role): IMResponse
设置角色
Parameters
- uid: string
  用户id
- rid: string
  房间id
- role: string
  角色
Returns IMResponse