概述

聊天室(Chatroom SDK)产品是基于低时延、高并发的全球实时消息系统框架开发的一套的房间聊天互动的产品。

接入聊天室SDK,开发者不但可以获得聊天室内的消息互动能力,更可以获得丰富的增值功能,如禁言、踢人、权限管理等。

聚联云实时消息产品SDK的代号为Hummer

  • HMR 接口类提供了 SDK 初始化登录以及配置的功能。
  • ChatRoomService 接口类提供了对应的聊天室管理的调用接口。
  • ChatService 接口类提供了消息发送的通道,可以用于发送对应的公屏、信令广播和信令单播。

基础方法

方法功能
HMR.getStateHummerSDK 当前所处的状态
getState标识长连接通道的状态
init初始化SDK
open登录SDK
close退出SDK
refreshToken刷新用户凭证
addStateListener添加SDK状态监听
removeStateListener移除SDK状态监听
addTokenInvalidListener添加token失效监听器
removeTokenInvalidListener移除token失效监听器
addChannelStateListener添加通道状态通知的监听器
removeChannelStateListener移除通道状态通知的监听器
getVersion获取sdk 版本信息
getService获取Hummer服务实例
回调功能
onUpdateHummerStateSDK状态变化回调
onHummerTokenInvalidToken过期回调
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收到消息后回调
<