概述

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

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

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

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

基础方法

方法功能
HMRInit初始化SDK
HMROpen登录SDK
HMRClose退出SDK
HMRRefreshToken刷新用户凭证
HMRSetLogger通过该方法进行设置对应的 Logger
HMRAddStateListener添加SDK状态监听
HMRRemoveStateListener移除SDK状态监听
HMRGetStateHummerSDK 当前所处的状态
HMRGetVersion获取sdk 版本信息
回调功能
onStateCallbackSDK状态变化回调
onTokenInvalidCallbackToken过期回调

聊天室管理

方法功能
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收到消息回调
<