聊天室(Chatroom SDK)产品是基于低时延、高并发的全球实时消息系统框架开发的一套的房间聊天互动的产品。
接入聊天室SDK,开发者不但可以获得聊天室内的消息互动能力,更可以获得丰富的增值功能,如禁言、踢人、权限管理等。
实时消息产品SDK的代号为Hummer
。
方法 | 功能 |
---|---|
HMR.getState | HummerSDK 当前所处的状态 |
getState | 标识长连接通道的状态 |
init | 初始化SDK |
open | 登录SDK |
close | 退出SDK |
refreshToken | 刷新用户凭证 |
addStateListener | 添加SDK状态监听 |
removeStateListener | 移除SDK状态监听 |
addTokenInvalidListener | 添加token失效监听器 |
removeTokenInvalidListener | 移除token失效监听器 |
addChannelStateListener | 添加通道状态通知的监听器 |
removeChannelStateListener | 移除通道状态通知的监听器 |
getVersion | 获取sdk 版本信息 |
getService | 获取Hummer服务实例 |
回调 | 功能 |
---|---|
onUpdateHummerState | SDK状态变化回调 |
onHummerTokenInvalid | Token过期回调 |
onUpdateChannelState | 长连接状态变化时回调 |
方法 | 功能 |
---|---|
setRegion | 设置聊天室区域 |
createChatRoom | 创建聊天室 |
dismissChatRoom | 解散聊天室 |
fetchBasicInfo | 获取聊天室信息 |
changeBasicInfo | 修改聊天室信息 |
addListener | 添加聊天室监听 |
removeListener | 移除聊天室监听 |
方法 | 功能 |
---|---|
onChatRoomDismissed | 聊天室解散回调 |
onBasicInfoChanged | 聊天室信息修改回调 |
方法 | 功能 |
---|---|
join | 加入聊天室 |
leave | 退出聊天室 |
kick | 将用户踢出聊天室 |
addRole | 添加角色 |
removeRole | 移除角色 |
fetchMembers | 获取聊天室在线成员列表 |
fetchRoleMembers | 获取角色列表 |
muteMember | 禁言聊天室内的成员 |
unmuteMember | 解禁成员 |
fetchMutedUsers | 获取禁言列表 |
isMuted | 判断成员是否禁言 |
setUserInfo | 设置自己的用户信息 |
deleteUserInfoByKeys | 删除自己的用户信息 |
fetchUserInfo | 获取指定用户的用户信息 |
fetchOnlineUserInfoList | 获取聊天室已设置用户信息的在线成员列表 |
addMemberListener | 添加聊天室成员监听 |
removeMemberListener | 移除聊天室成员监听 |
回调 | 功能 |
---|---|
onMemberJoined | 聊天室成员加入回调 |
onMemberLeaved | 聊天室成员离开回调 |
onMemberCountChanged | 聊天室成员人数变化回调 |
onMemberKicked | 聊天室成员被踢回调 |
onRoleAdded | 聊天室成员添加角色回调 |
onRoleRemoved | 聊天室成员移除角色回调 |
onMemberMuted | 聊天室成员被禁言回调 |
onMemberUnmuted | 聊天室成员被解除禁言回调 |
onUserInfoSet | 聊天室成员信息被设置时的回调 |
onUserInfoDeleted | 聊天室成员信息被删除时的回调 |
方法 | 功能 |
---|---|
send | 发送消息(公屏、单播、广播) |
addMessageListener | 添加消息监听 |
removeMessageListener | 移除消息监听 |
回调 | 功能 |
---|---|
beforeSendingMessage | 发送消息前回调 |
afterSendingMessage | 发送消息后回调 |
beforeReceivingMessage | 收到消息前回调 |
afterReceivingMessage | 收到消息后回调 |