聊天室(Chatroom SDK)产品是基于低时延、高并发的全球实时消息系统框架开发的一套的聊天室聊天互动的产品。
接入聊天室SDK,开发者不但可以获得房间内的消息互动能力,更可以获得丰富的增值功能,如禁言、权限管理等。
实时消息产品SDK的代号为Hummer
。
方法 | 功能 |
---|---|
getState | HummerSDK 当前所处的状态 |
getConnectionState | 标识长连接通道的状态 |
init | 初始化SDK |
open | 登录SDK |
close | 退出SDK |
refreshToken1 | 刷新用户凭证 |
addStateListener | 添加SDK状态监听 |
removeStateListener | 移除SDK状态监听 |
addTokenInvalidListener | 添加token失效监听器 |
removeTokenInvalidListener | 移除token失效监听器 |
addHummerListener | 添加Hummer状态通知的监听 |
removeHummerListener | 移除Hummer状态通知的监听器 |
getVersion | 获取sdk 版本信息 |
getService | 获取Hummer服务实例 |
setLoggerFilePath | 需要设置的日志存储路径,调用方应确保路径存在 |
setLogLevel | 设置日志输出级别 |
setLogCallback | 设置日志输出回调 |
uploadLogsManually | 手动上报日志 |
createTextMessage | 创建文本消息对象 |
sendP2PMessage | 发送单播点对点消息 |
fetchUserOnlineStatus | 查询目标用户当前的系统在线状态 |
回调 | 功能 |
---|---|
onUpdateHummerState | SDK状态变化回调 |
onHummerTokenWillExpired | Token过期回调 |
onHummerPreviousTokenExpired | Token过期回调 |
onConnectionStateChanged | 长连接状态变化时回调 |
onForceoutOffline | 账号被踢通知 |
onP2PTextMessageReceived | 接收点对点文本消息通知 |
方法 | 功能 |
---|---|
setRegion | 设置房间区域 |
createChatRoom | 创建房间 |
dismissChatRoom | 解散房间 |
fetchRoomBasicAttributes | 获取房间基本属性 |
fetchChatRoomInfo | 获取房间全部信息 |
fetchMemberCount | 获取房间人数 |
updateRoomBasicAttributes | 更新房间基本属性 |
addOrUpdateChatRoomInfo | 添加或更新房间信息 |
fetchHistoryMessages | 获取房间公屏历史消息 |
setRoomExtraAttributes | 设置房间扩展属性 |
updateRoomExtraAttributes | 更新房间扩展属性 |
deleteRoomExtraAttributes | 删除房间扩展属性 |
clearRoomExtraAttributes | 清空房间扩展属性 |
fetchRoomExtraAttributes | 获取房间扩展属性 |
addListener | 添加房间监听 |
removeListener | 移除房间监听 |
方法 | 功能 |
---|---|
onChatRoomDismissed | 房间解散回调 |
onRoomBasicAttributesUpdated | 房间基础属性更新通知 |
onRoomInfoAddedOrUpdated | 房间信息新增或更新回调 |
onRoomExtraAttributesSet | 房间扩展属性设置通知 |
onRoomExtraAttributesUpdated | 房间扩展属性更新通知 |
onRoomExtraAttributesDeleted | 房间扩展属性删除通知 |
onRoomExtraAttributesCleared | 房间扩展属性清空通知 |
方法 | 功能 |
---|---|
join | 加入房间 |
leave | 退出房间 |
kickUser | 将用户踢出房间 |
setUserRole | 设置用户角色 |
deleteUserRole | 删除用户角色 |
fetchMembers | 获取房间在线用户列表 |
fetchUserRole | 获取用户角色 |
fetchRoleMembers | 获取角色列表 |
fetchRoomUsersByRole | 根据角色获取用户列表 |
muteMember | 禁言房间内的用户 |
unmuteMember | 解禁用户 |
fetchMutedUsers | 获取禁言列表 |
isMuted | 判断用户是否禁言 |
setUserInfo | 设置自己的用户信息 |
deleteUserInfoByKeys | 删除自己的用户信息 |
addOrUpdateUserInfo | 添加或更新指定用户信息 |
fetchUserInfo | 获取指定用户的用户信息 |
batchFetchUserInfos | 批量获取指定用户的用户信息 |
fetchOnlineUserInfoList | 获取房间已设置用户信息的在线用户列表 |
addMemberListener | 添加用户监听 |
removeMemberListener | 移除用户监听 |
回调 | 功能 |
---|---|
onMemberJoined | 用户加入回调 |
onChatRoomMemberOffline | 房间断网超时回调 |
onChatRoomMemberLeave | 用户离开回调 |
onMemberCountChanged | 用户人数变化回调 |
onUserKicked | 用户被踢回调 |
onRoleAdded | 用户添加角色回调 |
onUserRoleSet | 设置用户角色通知 |
onUserRoleDeleted | 删除用户角色通知 |
onMemberMuted | 用户被禁言回调 |
onMemberUnmuted | 用户被解除禁言回调 |
onUserInfoSet | 用户信息被设置时的回调 |
onUserInfoDeleted | 用户信息被删除时的回调 |
onUserInfoAddedOrUpdated | 用户信息新增或更新时的回调 |
方法 | 功能 |
---|---|
getInstance | 获取消息通道实例 |
joinChannel | 加入消息通道 |
leaveChannel | 离开消息通道 |
sendP2CMessage | 在消息通道内发送广播消息 |
回调 | 功能 |
---|---|
onP2CTextMessageReceived | 接收到消息通道内文本广播消息时回调 |
方法 | 功能 |
---|---|
send | 发送消息(公屏、单播、广播) |
addMessageListener | 添加消息监听 |
removeMessageListener | 移除消息监听 |
回调 | 功能 |
---|---|
beforeSendingMessage | 发送消息前回调 |
afterSendingMessage | 发送消息后回调 |
beforeReceivingMessage | 收到消息前回调 |
afterReceivingMessage | 收到消息后回调 |