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

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

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

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

基础方法

方法功能
getStateHummerSDK 当前所处的状态
getConnectionState标识长连接通道的状态
init初始化SDK
open登录SDK
close退出SDK
refreshToken1刷新用户凭证
addStateListener添加SDK状态监听
removeStateListener移除SDK状态监听
addTokenInvalidListener添加token失效监听器
removeTokenInvalidListener移除token失效监听器
addHummerListener添加Hummer状态通知的监听
removeHummerListener移除Hummer状态通知的监听器
getVersion获取sdk 版本信息
getService获取Hummer服务实例
setLoggerFilePath需要设置的日志存储路径,调用方应确保路径存在
setLogLevel设置日志输出级别
setLogCallback设置日志输出回调
uploadLogsManually手动上报日志
createTextMessage创建文本消息对象
sendP2PMessage发送单播点对点消息
fetchUserOnlineStatus查询目标用户当前的系统在线状态
回调功能
onUpdateHummerStateSDK状态变化回调
onHummerTokenWillExpiredToken过期回调
onHummerPreviousTokenExpiredToken过期回调
onConnectionStateChanged长连接状态变化时回调
onForceoutOffline账号被踢通知
onP2PTextMessageReceived接收点对点文本消息通知

房间管理

方法功能
setRegion设置房间区域
createChatRoom创建房间
dismissChatRoom解散房间
fetchRoomBasicAttributes获取房间基本属性
fetchChatRoomInfo获取房间全部信息
fetchMemberCount获取房间人数
updateRoomBasicAttributes更新房间基本属性
addOrUpdateChatRoomInfo添加或更新房间信息
fetchHistoryMessages获取房间公屏历史消息
setRoomExtraAttributes设置房间扩展属性
updateRoomExtraAttributes更新房间扩展属性
deleteRoomExtraAttributes删除房间扩展属性
clearRoomExtraAttributes清空房间扩展属性
fetchRoomExtraAttributes获取房间扩展属性
addListener添加房间监听
removeListener移除房间监听
方法功能
onChatRoomDismissed房间解散回调
onRoomBasicAttributesUpdated房间基础属性更新通知
onRoomInfoAddedOrUpdated房间信息新增或更新回调
onRoomExtraAttributesSet房间扩展属性设置通知
onRoomExtraAttributesUpdated房间扩展属性更新通知
onRoomExtraAttributesDeleted房间扩展属性删除通知
onRoomExtraAttributesCleared房间扩展属性清空通知

用户管理

方法功能
join加入房间
leave退出房间
kickUser将用户踢出房间
setUserRole设置用户角色
deleteUserRole删除用户角色
fetchMembers获取房间在线用户列表
fetchUserRole获取用户角色
fetchRoleMembers获取角色列表
fetchRoomUsersByRole根据角色获取用户列表
muteMember禁言房间内的用户
unmuteMember解禁用户
fetchMutedUsers获取禁言列表
isMuted判断用户是否禁言
setUserInfo设置自己的用户信息
deleteUserInfoByKeys删除自己的用户信息
addOrUpdateUserInfo添加或更新指定用户信息
fetchUserInfo获取指定用户的用户信息
batchFetchUserInfos批量获取指定用户的用户信息
fetchOnlineUserInfoList获取房间已设置用户信息的在线用户列表
addMemberListener添加用户监听
removeMemberListener移除用户监听
回调功能
onMemberJoined用户加入回调
onChatRoomMemberOffline房间断网超时回调
onChatRoomMemberLeave用户离开回调
onMemberCountChanged用户人数变化回调
onUserKicked用户被踢回调
onRoleAdded用户添加角色回调
onUserRoleSet设置用户角色通知
onUserRoleDeleted删除用户角色通知
onMemberMuted用户被禁言回调
onMemberUnmuted用户被解除禁言回调
onUserInfoSet用户信息被设置时的回调
onUserInfoDeleted用户信息被删除时的回调
onUserInfoAddedOrUpdated用户信息新增或更新时的回调

消息通道管理

方法功能
getInstance获取消息通道实例
joinChannel加入消息通道
leaveChannel离开消息通道
sendP2CMessage在消息通道内发送广播消息
回调功能
onP2CTextMessageReceived接收到消息通道内文本广播消息时回调

消息服务

方法功能
send发送消息(公屏、单播、广播)
addMessageListener添加消息监听
removeMessageListener移除消息监听
回调功能
beforeSendingMessage发送消息前回调
afterSendingMessage发送消息后回调
beforeReceivingMessage收到消息前回调
afterReceivingMessage收到消息后回调

文档是否有解决您的问题?

有帮助 没帮助
提交成功,非常感谢您的反馈!

反馈

TOP