提供各种客户端SDK,通过SDK连接全球部署的实时通信网络,来为开发者提供质量稳定可靠、高并发、超低时延的实时信令服务(Real-Time Signaling,RTS),帮助你实现快速构建业务场景。
PC端特有的即时消息服务SDK代号为Hummer
。
方法 | 功能 |
---|---|
init | 初始化Hummer,同时开始监听Hummer的状态改变 |
getSDKVersion | 获取Hummer的版本号 |
login | 登录SDK |
logout | 登出SDK |
getState | 获取HummerSDK 当前所处的状态 |
refreshToken | 刷新用户凭证 |
setLoggerFilePath | 日志根目录路径 |
回调 | 功能 |
---|---|
onHummerLogin | Hummer登陆结果回调 |
onRefreshToken | 用户凭证刷新结果回调 |
通知 | 功能 |
---|---|
onHummerStateChanged | SDK状态变化通知 |
onHummerKicked | SDK收到多端登录被踢的通知 |
onHummerPreviousTokenExpired | 用户凭证过期通知 |
方法 | 功能 |
---|---|
addEventHandler | 添加信令消息的监听器 |
removeEventHandler | 移除信令消息的监听器 |
sendMessage | 发送点对点信令消息 |
queryUserOnlineStatus | 批量查询用户在线,可以查询具体用户是否在线 |
回调 | 功能 |
---|---|
onSendMessage | 当发送点对点信令消息时,结果通过该事件进行回调 |
onQueryUserOnlineStatus | 批量查询用户在线结果回调 |
通知 | 功能 |
---|---|
onPeerMessageReceived | 当收到点对点信令消息时,会收到该事件的通知 |
方法 | 功能 |
---|---|
sendMessage | 发送房间消息 |
addRoomEventHandler | 添加房间的监听器 |
removeRoomEventHandler | 移除房间的监听器 |
setRoomAttributes | 设置房间属性(支持进房间和不进房间全量设置房间属性) |
addOrUpdateRoomAttributes | 更新指定房间的属性:属性存在则更新;属性不存在则添加 |
deleteRoomAttributes | 删除指定房间的指定属性 |
clearRoomAttributes | 清空指定房间属性 |
queryRoomAttributes | 查询指定房间的全部属性 |
queryRoomAttributesByKeys | 查询指定房间的指定属性 |
queryMemberCounts | 批量查询房间成员总数 |
queryMembers | 获取房间成员列表 |
回调 | 功能 |
---|---|
onQueryMembers | 房间成员列表查询结果回调 |
onQueryMemberCounts | 房间成员查询结果回调 |
onSendMessage | 发送房间消息结果回调 |
onSetRoomAttributes | 设置房间属性设置结果回调 |
onAddOrUpdateRoomAttributes | 更新指定房间的属性结果回调 |
onDeleteRoomAttributes | 删除房间属性结果回调 |
onClearRoomAttributes | 清除房间所有属性结果回调 |
onQueryRoomAttributes | 查询房间所有属性结果回调 |
onQueryRoomAttributesByKeys | 查询房间指定属性结果回调 |
通知 | 功能 |
---|---|
onRoomMessageReceived | 当有一个用户往房间内发一条信令消息时,房间内所有的成员都会受到该事件的通知 |
onRoomAttributesSet | 房间属性设置通知 |
onRoomAttributesDeleted | 房间属性删除通知 |
onRoomAttributesCleared | 房间属性清空通知 |
onRoomAttributesAddedOrUpdated | 房间属性新增或更新通知 |
方法 | 功能 |
---|---|
joinRoom | 进入房间的接口 |
leaveRoom | 退出房间的接口 |
addMemberEventHandler | 添加成员事件的监听器 |
removeMemberEventHandler | 移除成员的监听器 |
setMemberAttributes | 设置用户在当前房间的信息 |
addOrUpdateMemberAttributes | 添加或更新用户在当前房间的信息 |
deleteMemberAttributes | 删除用户在当前房间的某些信息 |
clearMemberAttributes | 删除用户在当前房间的所有信息 |
queryMemberAttributes | 查询用户在当前房间的全部属性 |
queryMemberAttributesByKeys | 查询用户在房间的指定属性 |
回调 | 功能 |
---|---|
onJoinRoom | 进入房间结果回调 |
onLeaveRoom | 离开房间结果回调 |
onSetMemberAttributes | 房间成员属性设置结果回调 |
onAddOrUpdateMemberAttributes | 房间成员属性更新结果回调 |
onClearMemberAttributes | 清除房间成员所有属性结果回调 |
onDeleteMemberAttributes | 房间成员属性删除结果回调 |
onQueryMemberAttributes | 查询房间成员所有属性结果回调 |
onQueryMemberAttributesByKeys | 查询房间成员指定属性结果回调 |
通知 | 功能 |
---|---|
onRoomMemberJoined | 成员进入房间通知 |
onRoomMemberLeft | 成员离开房间通知 |
onRoomMemberOffline | 当前用户断线超时离开房间通知 |
onRoomMemberCountChanged | 房间人数变更通知 |
onRoomMemberAttributesSet | 房间成员信息设置回调通知 |
onRoomMemberAttributesDeleted | 房间成员信息删除回调通知 |
onRoomMemberAttributesCleared | 房间成员信息清空回调通知 |
onRoomMemberAttributesAddedOrUpdated | 房间成员信息新增或更新回调通知 |