聊天室(Chatroom SDK)产品是基于低时延、高并发的全球实时消息系统框架开发的一套的房间聊天互动的产品。
接入聊天室SDK,开发者不但可以获得聊天室内的消息互动能力,更可以获得丰富的增值功能,如禁言、踢人、权限管理等。
实时消息产品SDK的代号为Hummer
。
方法 | 功能 |
---|---|
HMRInit | 初始化SDK |
HMROpen | 登录SDK |
HMRClose | 退出SDK |
HMRRefreshToken | 刷新用户凭证 |
HMRSetLogger | 通过该方法进行设置对应的 Logger |
HMRAddStateListener | 添加SDK状态监听 |
HMRRemoveStateListener | 移除SDK状态监听 |
HMRGetState | HummerSDK 当前所处的状态 |
HMRGetVersion | 获取sdk 版本信息 |
回调 | 功能 |
---|---|
onStateCallback | SDK状态变化回调 |
onTokenInvalidCallback | Token过期回调 |
方法 | 功能 |
---|---|
HMRCreateChatRoom | 创建聊天室 |
HMRCreateChatRoomWithInfo | 创建聊天室,并配置聊天室信息 |
HMRJoinChatRoom | 加入聊天室 |
HMRJoinChatRoomWithMultiCheck | 加入聊天室,并检测当前用户是否重复登陆 |
HMRJoinChatRoomWithConfigs | 加入聊天室,并指定扩展信息 |
HMRLeaveChatRoom | 退出聊天室 |
HMRChatRoomChangeBasicInfo: | 获取聊天室基本属性信息 |
HMRChatRoomChangeBasicInfo | 变更聊天室基本属性信息 |
HMRAddChatRoomListener | 添加聊天室回调监听器 |
HMRRemoveChatRoomListener | 移除聊天室回调监听器 |
HMRMakeChatRoomIdentity | 构造一个聊天室Identity对象 |
HMRExtractChatRoomId | 从聊天室Identity对象中抽取聊天室Id值 |
HMRIsChatRoom | 判断一个Identity对象是否表示一个聊天室 |
回调 | 功能 |
---|---|
onBasicInfoChanged | 聊天室信息修改回调 |
方法 | 功能 |
---|---|
HMRChatRoomFetchMembers | 获取聊天室在线成员列表 |
HMRChatRoomSetUserInfo | 设置自己的用户信息 |
HMRChatRoomFetchOnLineUserInfoList | 获取聊天室已设置用户信息的在线成员列表 |
HMRAddMemberListener | 添加聊天室成员监听 |
HMRRemoveMemberListener | 移除聊天室成员监听 |
HMRMakeChatRoomUser | 构造一个聊天室用户Identity对象 |
HMRExtractChatRoomUser | 从聊天室用户Identity对象中抽取用户Id值 |
HMRIsChatRoomUser | 判断一个Identity对象是否表示一个聊天室用户 |
回调 | 功能 |
---|---|
onMemberJoined | 当聊天室成员加入回调 |
onMemberLeaved | 聊天室成员离开回调 |
onMemberCountChanged | 聊天室成员人数变化回调 |
onMemberKicked | 聊天室成员被踢回调 |
onUserInfoSet | 聊天室成员信息被设置时的回调 |
方法 | 功能 |
---|---|
HMRSendMessasge | 发送消息(公屏、单播、广播) |
HMRAddMessageListener | 添加消息监听 |
HMRRemoveMessageListener | 移除消息监听 |
HMRCreateMessage | 创建一条消息 |
HMRRetainMessage | 持有一条消息的引用 |
HMRReleaseMessage | 释放一条消息的引用 |
HMRMakeMessageExtra | 构造消息扩展内容 |
HMRIsMessageFailed | 判断消息是否为失败状态 |
HMRGetConversationTarget | 根据消息对象获取其对应的会话目标 |
回调 | 功能 |
---|---|
beforeSending | 发送消息前回调 |
afterSending | 发送消息后回调 |
onReceive | 收到消息回调 |