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

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

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

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

基础功能

方法功能
stateHummerSDK 当前所处的状态
connectionState标识长连接通道的状态
startSDKWithAppId初始化SDK
openWithUid登录SDK
closeWithCompletionHandler退出SDK
refreshToken1刷新用户凭证
setLogger通过该方法进行设置对应的 Logger
addStateObserver添加SDK状态监听
removeStateObserver移除SDK状态监听
addHummerObserver添加Hummer状态通知的监听器
removeHummerObserver移除Hummer状态通知的监听器
sdkVersion获取sdk 版本信息
setLoggerFilePath需要设置的日志存储路径,调用方应确保路径存在
setLogLevel设置日志输出级别
setLogger设置日志输出代理
uploadLogsManually手动上报日志
sendP2PMessage发送单播点对点消息
fetchUserOnlineStatus查询目标用户当前的系统在线状态
通知功能
didUpdateStateFromSDK状态变化通知
didHummerPreviousTokenExpiredToken过期通知
didConnectionStateChanged长连接状态变化时通知
didHummerTokenWillExpireToken即将过期通知
didForceoutOffline账号被踢通知
didP2PTextMessageReceived接收点对点文本消息通知

房间管理

方法功能
instance创建实例并初始化
setRegion设置房间区域
createchatRoom创建房间
dismisschatRoom解散房间
fetchRoomBasicAttributes获取房间基本属性
fetchChatRoomInfo获取房间全部信息
fetchMemberCount获取房间人数
updateRoomBasicAttributes更新房间基本属性
fetchHistoryMessages获取房间公屏历史消息
setRoomExtraAttributes设置房间扩展属性
updateRoomExtraAttributes更新房间扩展属性
deleteRoomExtraAttributes删除房间扩展属性
clearRoomExtraAttributes清空房间扩展属性
fetchRoomExtraAttributes获取房间扩展属性
addChatRoomObserver添加房间监听
removeChatRoomObserver移除房间监听
通知功能
didDismissByOperator房间解散通知
didRoomBasicAttributesUpdated房间基础属性被修改通知
didRoomExtraAttributesSet房间扩展属性设置通知
didRoomExtraAttributesUpdated房间扩展属性更新通知
didRoomExtraAttributesDeleted房间扩展属性删除通知
didRoomExtraAttributesCleared房间扩展属性清空通知

用户管理

方法功能
instance创建实例并初始化
joinchatRoomextraProps加入房间
leavechatRoom退出房间
kickUser将用户踢出房间
setUserRole设置用户角色
deleteUserRole删除用户角色
fetchMembers获取房间在线用户列表
fetchUserRole获取用户角色
fetchRoomUsersByRole根据角色获取用户列表
muteMember禁言房间内的用户
unmuteMember解禁用户
fetchMutedUsers获取禁言列表
isUserMuted判断用户是否禁言
setUserInfo设置自己的用户信息
deleteUserInfo删除自己的用户信息
addOrUpdateUserInfo添加或更新指定用户信息
fetchUserInfo获取指定用户的用户信息
batchFetchUserInfos批量获取指定用户的用户信息
fetchOnlineUserInfoList获取房间已设置用户信息的在线用户列表
addMemberObserver添加用户监听
removeMemberObserver移除用户监听
通知功能
didJoinMembers用户加入通知
didChatRoomMemberOffline用户断网超时通知
didChatRoomMemberLeave用户离开通知
didChangeMemberCount用户人数变化通知
didUserKicked用户被踢通知
didUserRoleSet设置用户角色通知
didUserRoleDeleted删除用户角色通知
didMuteMembers用户被禁言通知
didUnmuteMembers用户被解除禁言通知
didUserInfoSet用户信息被设置时的通知
didUserInfoDeleted用户信息被删除时的通知
didUserInfoAddedOrUpdated用户信息新增或更新时的通知

消息通道管理

方法功能
instance获取消息通道实例
joinChannel加入消息通道
leaveChannel离开消息通道
sendP2CMessage在消息通道内发送广播消息
通知功能
didP2CTextMessageReceived:message:fromUser:接收到消息通道内文本广播消息时通知

消息服务

方法功能
instance创建实例并初始化
sendMessage发送消息(公屏、单播、广播)
addMessageObserver添加消息监听
removeMessageObserver移除消息监听
通知功能
willSendMessage发送消息前通知
didSendMessage发送消息后通知
willReceiveMessage收到消息前通知
didReceiveMessage收到消息后通知

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

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

反馈

TOP