概述

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

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

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

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

基础方法

方法功能
stateHummerSDK 当前所处的状态
channelState标识长连接通道的状态
startSDKWithAppId:初始化SDK
openWithUid:environment:msgFetchStrategy:tags:token:completionHandler:登录SDK
closeWithCompletionHandler:退出SDK
refreshToken:刷新用户凭证
setLogger:通过该方法进行设置对应的 Logger
addStateObserver:添加SDK状态监听
removeStateObserver:移除SDK状态监听
addChannelStateObserver:添加通道状态通知的监听器
removeChannelStateObserver:移除通道状态通知的监听器
sdkVersion获取sdk 版本信息
回调功能
didUpdateStateFrom:toState:SDK状态变化回调
didHummerTokenInvalid:withDescription:Token过期回调
didChangeChannelStateFrom:toState:长连接状态变化时回调

聊天室管理

方法功能
instance创建实例并初始化
setRegion:设置聊天室区域
createChatRoom:completionHandler:创建聊天室
dismissChatRoom:completionHandler:解散聊天室
fetchBasicInfo:completionHandler:获取聊天室信息
changeBasicInfo:forChatRoom:completionHandler:修改聊天室信息
addChatRoomObserver:添加聊天室监听
removeChatRoomObserver:移除聊天室监听
回调功能
chatRoom:didDismissByOperator:聊天室解散回调
chatRoom:didChangeBasicInfo:byOperator:聊天室信息修改回调

聊天室成员管理

方法功能
instance创建实例并初始化
joinChatRoom:extraProps:completionHandler:加入聊天室
leaveChatRoom:completionHandler:退出聊天室
kickMember:fromChatRoom:extraInfo:completionHandler:将用户踢出聊天室
addRole:forMember:chatRoom:completionHandler:添加角色
removeRole:forMember:chatRoom:completionHandler:移除角色
fetchMembers:offset:num:completionHandler:获取聊天室在线成员列表
fetchRoleMembers:onlineOnly:completionHandler:获取角色列表
muteMember:inChatRoom:reason:completionHandler:禁言聊天室内的成员
unmuteMember:inChatRoom:reason:completionHandler:解禁成员
fetchMutedUsers:completionHandler:获取禁言列表
isUserMuted:inChatRoom:completionHandler:判断成员是否禁言
setUserInfo:inChatRoom:completionHandler:设置自己的用户信息
deleteUserInfo:byKeys:completionHandler:删除自己的用户信息
fetchUserInfo:inChatRoom:completionHandler:获取指定用户的用户信息
fetchOnlineUserInfoList:completionHandler:获取聊天室已设置用户信息的在线成员列表
addMemberObserver:添加聊天室成员监听
removeMemberObserver:移除聊天室成员监听
回调功能
chatRoom:didJoinMembers:聊天室成员加入回调
chatRoom:didLeaveMembers:reason:leavingType:聊天室成员离开回调
chatRoom:didChangeMemberCount:聊天室成员人数变化回调
chatRoom:didKickMembers:byOperator:reason:聊天室成员被踢回调
chatRoom:didAddRole:forMember:byOperator:聊天室成员添加角色回调
chatRoom:didRemoveRole:forMember:byOperator:聊天室成员移除角色回调
chatRoom:didMuteMembers:byOperator:reason:聊天室成员被禁言回调
chatRoom:didUnmuteMembers:byOperator:reason:聊天室成员被解除禁言回调
chatRoom:didUserInfoSet:infos:聊天室成员信息被设置时的回调
chatRoom:didUserInfoDeleted:infos:聊天室成员信息被删除时的回调

消息通道

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