聊天室(Chatroom SDK)产品是基于低时延、高并发的全球实时消息系统框架开发的一套的聊天室聊天互动的产品。
接入聊天室SDK,开发者不但可以获得聊天室内的消息互动能力,更可以获得丰富的增值功能,如禁言、踢人、权限管理等。
实时消息产品SDK的代号为Hummer
。
方法 | 功能 |
---|---|
HMRInit | 初始化SDK |
HMROpen | 登录SDK |
HMRClose | 退出SDK |
HMRRefreshToken1 | 刷新用户凭证 |
HMRSetLogger | 通过该方法进行设置对应的 Logger |
HMRAddStateListener | 添加SDK状态监听 |
HMRRemoveStateListener | 移除SDK状态监听 |
HMRAddHummerListener | 添加连接状态监听 |
HMRRemoveHummerListener | 移除连接状态监听 |
HMRGetState | HummerSDK 当前所处的状态 |
HMRGetVersion | 获取sdk 版本信息 |
HMRSetLoggerFilePath | 需要设置的日志存储路径,调用方应确保路径存在 |
HMRSetLogLevel | 设置日志输出级别 |
HMRUploadLogsManually | 手动上报日志 |
HMRSetLogCallback | 设置日志输出回调 |
HMRAddPeerListener | 设置用户的监听器 |
HMRRemovePeerListener | 移除用户的监听器 |
HMRCreateTextMessage | 构建文本消息 |
HMRReleaseTextMessage | 释放文本消息 |
HMRSendP2PMessage | 发送P2P信令消息 |
HMRFetchUserOnlineStatus | 批量查询用户在线 |
回调 | 功能 |
---|---|
onStateCallback | SDK状态变化回调 |
onPreviousTokenExpiredCallback | Token过期回调 |
onConnectionStateChanged | Hummer连接状态变更回调 |
onTokenWillExpire | Token将要过期回调 |
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 | 收到通道信息的通知 |