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

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

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

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

基础方法

方法功能
HMRInit初始化SDK
HMROpen登录SDK
HMRClose退出SDK
HMRRefreshToken1刷新用户凭证
HMRSetLogger通过该方法进行设置对应的 Logger
HMRAddStateListener添加SDK状态监听
HMRRemoveStateListener移除SDK状态监听
HMRAddHummerListener添加连接状态监听
HMRRemoveHummerListener移除连接状态监听
HMRGetStateHummerSDK 当前所处的状态
HMRGetVersion获取sdk 版本信息
HMRSetLoggerFilePath需要设置的日志存储路径,调用方应确保路径存在
HMRSetLogLevel设置日志输出级别
HMRUploadLogsManually手动上报日志
HMRSetLogCallback设置日志输出回调
HMRAddPeerListener设置用户的监听器
HMRRemovePeerListener移除用户的监听器
HMRCreateTextMessage构建文本消息
HMRReleaseTextMessage释放文本消息
HMRSendP2PMessage发送P2P信令消息
HMRFetchUserOnlineStatus批量查询用户在线
回调功能
onStateCallbackSDK状态变化回调
onPreviousTokenExpiredCallbackToken过期回调
onConnectionStateChangedHummer连接状态变更回调
onTokenWillExpireToken将要过期回调
onForceoutOffline登录被踢回调
onP2PMessageReceived收到P2P信息的通知

房间管理

方法功能
HMRCreateChatRoom创建房间
HMRCreateChatRoomWithInfo创建房间,并配置房间信息
HMRJoinChatRoom加入房间
HMRJoinChatRoomWithMultiCheck加入房间,并检测当前用户是否重复登陆
HMRJoinChatRoomWithConfigs加入房间,并指定扩展信息
HMRLeaveChatRoom退出房间
HMRChatRoomChangeBasicInfo变更房间基本属性信息
HMRAddChatRoomListener添加房间回调监听器
HMRRemoveChatRoomListener移除房间回调监听器
HMRMakeChatRoomIdentity构造一个房间Identity对象
HMRExtractChatRoomId从房间Identity对象中抽取房间Id值
HMRIsChatRoom判断一个Identity对象是否表示一个房间
HMRChatRoomFetchRoomInfo获取房间所有属性
HMRChatRoomAddOrUpdateRoomInfo新增/更新房间属性
HMRSetRoomExtraAttributes设置房间扩展属性
HMRUpdateRoomExtraAttributes更新指定房间的扩展属性
HMRDeleteRoomExtraAttributes删除指定房间的指定属性
HMRClearRoomExtraAttributes删除用户在当前房间的所有信息
HMRFetchRoomExtraAttributes查询指定房间的指定属性
HMRUpdateRoomBasicAttributes更新房间基础属性
HMRFetchRoomBasicAttributes查询指定房间的指定属性
回调功能
onBasicInfoChanged房间信息修改回调
onRoomExtraAttributesSet房间属性设置通知
onRoomExtraAttributesUpdated房间属性删除通知
onRoomExtraAttributesDeleted房间属性清空通知
onRoomExtraAttributesCleared房间用户信息清空回调通知
onRoomBasicAttributesUpdated房间基础属性设置通知

用户管理

方法功能
HMRChatRoomFetchMembers获取房间在线用户列表
HMRChatRoomSetUserInfo设置自己的用户信息
HMRChatRoomFetchOnLineUserInfoList获取房间已设置用户信息的在线用户列表
HMRAddMemberListener添加房间用户监听
HMRRemoveMemberListener移除房间用户监听
HMRGetChatRoomRegion获取房间服务地区代号
HMRSetChatRoomRegion设置房间服务地区代号
HMRMakeChatRoomUser构造一个房间用户Identity对象
HMRExtractChatRoomUser从房间用户Identity对象中抽取用户Id值
HMRIsChatRoomUser判断一个Identity对象是否表示一个房间用户
HMRChatRoomDeleteUserInfo删除用户属性
HMRChatRoomBatchFetchUserInfos批量获取用户属性
HMRChatRoomAddOrUpdateUserInfo新增/更新用户属性
HMRKickUser把聊天室内用户踢出聊天室
HMRSetUserRole设置聊天室用户角色
HMRDeleteUserRole删除用户角色
HMRFetchUserRole查询用户角色
HMRFetchRoleUserList查询角色用户列表
回调功能
onMemberJoined当房间用户加入回调
onMemberLeaved房间用户离开回调
onMemberCountChanged房间用户人数变化回调
onMemberOffline断网超时离线回调
onUserInfoSet房间用户信息被设置时的回调
onUserInfoAddedOrUpdated用户属性新增/更新通知
onUserInfoDeleted用户属性删除通知
onUserKicked用户被踢出聊天室的通知
onUserRoleSet设置用户角色通知
onUserRoleDeleted删除用户角色回调通知

消息服务

方法功能
HMRSendMessasge发送消息(公屏、单播、广播)
HMRAddMessageListener添加消息监听
HMRRemoveMessageListener移除消息监听
HMRCreateMessage创建一条消息
HMRRetainMessage持有一条消息的引用
HMRReleaseMessage释放一条消息的引用
HMRMakeMessageExtra构造消息扩展内容
HMRIsMessageFailed判断消息是否为失败状态
HMRGetConversationTarget根据消息对象获取其对应的会话目标
回调功能
beforeSending发送消息前回调
afterSending发送消息后回调
onReceive收到消息回调

消息通道管理

方法功能
HMRAddChannelListener设置通道的监听器
HMRRemoveChannelListener移除通道的监听器
HMRSendP2CMessage发送组消息
HMRJoinChannel进入通道
HMRLeaveChannel退出通道
回调功能
onP2CMessageReceived收到通道信息的通知

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

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

反馈

TOP