批量添加聊天室成员。
connection.addUsersToChatRoom({chatRoomId: "chatRoomId", users:['user1', 'user2']})
聊天室 ID。
要添加的用户。
批量增加聊天室白名单成员。加入白名单的成员会在 onPresence 收到 type: 'addUserToChatRoomWhiteList' 回调。
connection.addUsersToChatRoomWhitelist({chatRoomId: 'chatRoomId'})
聊天室 ID。
添加白名单的成员列表。
添加单个成员至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.blockChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
被添加的用户 ID。
批量添加用户至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.blockChatRoomMembers({usernames: ['user1', 'user2'], chatRoomId: 'chatRoomId'})
聊天室 ID。
要添加的成员用户 ID。
批量添加成员至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.chatRoomBlockMulti({usernames: ['user1', 'user2'], chatRoomId: 'chatRoomId'})
聊天室 ID。
要添加的成员用户 ID。
添加单个成员至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.chatRoomBlockSingle({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
被添加的用户 ID。
创建聊天室。
connection.createChatRoom({name: 'myChatRoom', description: 'this is my chatroom', maxusers: 200, members; ['user1']})
聊天室描述。
聊天室最大成员数（包括聊天室创建者），值为数值类型，默认值 200，最大值 5,000。
（可选）聊天室成员，由用户 ID 组成的数组。如果设置了该参数，请确保数组内至少包含一个用户。
聊天室名称。
超级管理员 token。
删除一个聊天室共享文件。
connection.deleteChatRoomSharedFile({roomId: 'roomId', fileId: 'fileId'})
文件 ID。
聊天室 ID。
销毁聊天室。
connection.destroyChatRoom({chatRoomId: 'chatRoomId'})
聊天室 ID。
超级管理员 token。
聊天室一键禁言。仅聊天室创建者和管理员可调用此方法。
connection.disableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
聊天室 ID。
聊天室解除一键禁言。仅聊天室创建者和管理员可调用此方法。
connection.enableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室公告。
connection.fetchChatRoomAnnouncement({roomId: 'roomId'})
聊天室 ID。
获取聊天室共享文件列表。
connection.fetchChatRoomSharedFileList({roomId: 'roomId'})
聊天室 ID。
获取聊天室的所有管理员。
connection.getChatRoomAdmin({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室黑名单。
connection.getChatRoomBlacklist({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室黑名单。
connection.getChatRoomBlacklistNew({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室详情。
connection.getChatRoomDetails({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室所有禁言成员。
connection.getChatRoomMuteList({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室所有被禁言成员。
connection.getChatRoomMuted({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取白聊天室白名单列表。仅聊天室所有者和管理员有权调用该方法。
connection.getChatRoomWhitelist({chatRoomId: 'chatRoomId'})
聊天室 ID。
分页获取聊天室列表。
connection.getChatRooms({pagenum: 1, pagesize: 20})
当前页码，从 1 开始。
每页记录数，默认 20。
查询聊天室成员是否是在白名单中。仅聊天室所有者和管理员有权调用该方法。普通成员可查询自己。
connection.isChatRoomWhiteUser({chatRoomId: 'chatRoomId', userName: 'user1'})
聊天室 ID。
用户 ID。
加入聊天室。用户成功加入聊天室后，其他成员会在 onChatroomChange 回调里收到 type:'memberJoinChatRoomSuccess'。
connection.joinChatRoom({roomId: 'roomId'})
原因，可选项(聊天室中未启用)。
聊天室的 ID。
分页列出聊天室的所有成员。
connection.listChatRoomMember({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
聊天室 ID。
当前页码，从 1 开始。
每页返回的成员数,最大值为 1,000。
分页列出聊天室的所有成员。
connection.listChatRoomMembers({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
聊天室 ID。
当前页码，从 1 开始。
每页返回的成员数,最大值为 1,000。
修改聊天室详情。
connection.modifyChatRoom({chatRoomId: 'chatRoomId', chatRoomName: 'chatRoomName', description: 'description', maxusers: 5000})
聊天室 ID。
聊天室名称。
聊天室描述。
聊天室最大成员数。
禁止聊天室用户发言。该方法只有聊天室所有者才有权限调用。所有成员都会在 onPresence 的回调里收到 type:'addMute'。
connection.muteChatRoomMember({username: 'user1', muteDuration: -1, chatRoomId: 'chatRoomId'})
聊天室 ID。
禁言时长，单位为毫秒，如果是 -1 代表永久。
被禁言的聊天室成员。
退出聊天室。若某成员退出聊天室，其他成员会在 onPresence 回调里收到 type:leaveChatRoom。
connection.quitChatRoom({roomId: 'roomId'})
聊天室 ID。
移除聊天室管理员。该方法只有聊天室所有者才有权限调用。被移除管理员权限的用户会在 onPresence 的回调里收到 type: 'removeAdmin'。
connection.removeChatRoomAdmin({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
被移除管理员权限的用户。
批量将成员从聊天室黑名单移除。该方法只有聊天室所有者和管理员才有权限调用。
connection.removeChatRoomBlockMulti({chatRoomId: 'chatRoomId', usernames: ['user1', 'user2']})
聊天室 ID。
要移除聊天室黑名单的成员数组。
将单个用户从聊天室黑名单移除。该方法只有聊天室所有者和管理员才有权限调用。
connection.removeChatRoomBlockSingle({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
用户 ID。
移除单个聊天室成员。
connection.removeChatRoomMember({chatRoomId: 'chatRoomId', username: 'username'})
聊天室 ID。
要移除的用户 ID。
移除多个聊天室成员。
connection.removeChatRoomMembers({chatRoomId: 'chatRoomId', users: ['user1', 'user2']})
聊天室 ID。
要移除的成员。
移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。被移出白名单的成员会在 onPresence 的回调里收到 type: 'rmUserFromChatRoomWhiteList' 回调。
connection.removeChatRoomWhitelistMember({chatRoomId: 'chatRoomId', userName: 'user1'})
聊天室 ID。
要移出白名单的成员列表。
批量移除聊天室成员。
connection.removeMultiChatRoomMember({chatRoomId: 'chatRoomId', users: ['user1', 'user2']})
聊天室 ID。
要移除的成员。
解除对聊天室用户的禁言。该方法只有聊天室所有者和管理员才有权限调用。被解除禁言的用户和其他用户会在 onPresence 的回调里收到 type: 'removeMute'。
connection.removeMuteChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
要解除禁言的聊天室用户。
移除单个聊天室成员。
connection.removeSingleChatRoomMember({chatRoomId: 'chatRoomId', username: 'username'})
聊天室 ID。
要移除的用户 ID。
批量移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。被移除白名单的成员会在 onPresence 的回调里收到 type: 'rmUserFromChatRoomWhiteList' 回调。
connection.rmUsersFromChatRoomWhitelist({chatRoomId: 'chatRoomId', userName: 'user1'})
聊天室 ID。
要移出白名单的成员列表。
设置聊天室管理员。该方法只有聊天室所有者才有权限调用。被设置成管理员的用户会在 onPresence 的回调里收到 type: addAdmin。
connection.setChatRoomAdmin({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
设置为管理员的用户。
将单个成员从聊天室黑名单移除。该方法只有聊天室所有者和管理员才有权限调用。
connection.unblockChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
用户 ID。
批量将成员从聊天室黑名单移除。该方法只有聊天室所有者和管理员才有权限调用。
connection.unblockChatRoomMembers({chatRoomId: 'chatRoomId', usernames: ['user1', 'user2']})
聊天室 ID。
要移除聊天室黑名单的成员数组。
解除对聊天室用户的禁言。该方法只有聊天室所有者和管理员才有权限调用。被解除禁言的用户和其他用户会在 onPresence 的回调里收到 type: 'removeMute'。
connection.unmuteChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
要解除禁言的聊天室用户。
更新聊天室公告。
connection.updateChatRoomAnnouncement({roomId: 'roomId', announcement: 'hello'})
公告内容。
聊天室 ID。
上传一个聊天室共享文件。
connection.uploadChatRoomSharedFile({roomId: 'roomId', file: 'file object', onFileUploadProgress: onFileUploadProgress, onFileUploadComplete: onFileUploadComplete,onFileUploadError:onFileUploadError,onFileUploadCanceled:onFileUploadCanceled})
上传的文件对象。
聊天室 ID。
上传取消的回调。
上传完成的回调。
上传失败的回调。
上传进度的回调。
Void
Generated using TypeDoc
chat room apis