批量增加聊天室白名单成员。加入白名单的成员会在 onChatroomEvent 收到 operation: 'addUserToAllowlist' 回调。
connection.addUsersToChatRoomAllowlist({chatRoomId: 'chatRoomId'})
聊天室 ID。
添加白名单的成员列表。
添加单个成员至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.blockChatRoomMember({chatRoomId: 'chatRoomId', username: 'user1'})
聊天室 ID。
被添加的用户 ID。
批量添加用户至聊天室黑名单。该方法只有聊天室所有者和管理员才有权限调用。
connection.blockChatRoomMembers({usernames: ['user1', 'user2'], chatRoomId: 'chatRoomId'})
聊天室 ID。
要添加的成员用户 ID。
创建聊天室。
connection.createChatRoom({name: 'myChatRoom', description: 'this is my chatroom', maxusers: 200, members: ['user1'], token: 'your token'})
聊天室描述。
聊天室最大成员数（包括聊天室创建者），值为数值类型，默认值 200，最大值 5,000。
（可选）聊天室成员，由用户 ID 组成的数组。如果设置了该参数，请确保数组内至少包含一个用户。
聊天室名称。
超级管理员 token。
删除一个聊天室共享文件。
connection.deleteChatRoomSharedFile({roomId: 'roomId', fileId: 'fileId'})
文件 ID。
聊天室 ID。
销毁聊天室。
connection.destroyChatRoom({chatRoomId: 'chatRoomId', token: 'your token'})
聊天室 ID。
超级管理员 token。
聊天室一键禁言。仅聊天室创建者和管理员可调用此方法。聊天室成员会收到 muteAllMembers 事件。
connection.disableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
聊天室 ID。
聊天室解除一键禁言。
仅聊天室创建者和管理员可调用此方法。
聊天室成员会收到 unmuteAllMembers 回调。
connection.enableSendChatRoomMsg({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室公告。
connection.fetchChatRoomAnnouncement({roomId: 'roomId'})
聊天室 ID。
获取聊天室的所有管理员。
connection.getChatRoomAdmin({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室白名单列表。
仅聊天室所有者和管理员有权调用该方法。
connection.getChatRoomWhitelist({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室全部的自定义属性。
connection.getChatRoomAttributes({chatRoomId: 'chatRoomId', attributes:["attributeKey1","attributeKey2"]})
要获取的自定义属性。传对应的属性 key 会返回属性 value；不传值：返回全部属性。
聊天室 ID。
获取聊天室黑名单。
connection.getChatRoomBlocklist({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室详情。
connection.getChatRoomDetails({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室所有禁言成员。
connection.getChatRoomMutelist({chatRoomId: 'chatRoomId'})
聊天室 ID。
获取聊天室共享文件列表。
connection.getChatRoomSharedFilelist({roomId: 'roomId'})
聊天室 ID。
分页获取聊天室列表。
connection.getChatRooms({pagenum: 1, pagesize: 20})
当前页码，从 1 开始。
每页期望返回的聊天室数量，默认为 20。
获取用户加入的聊天室列表。
connection.getJoinedChatRooms({pageNum: 1, pageSize: 20})
当前页码，从 1 开始。
每页返回的聊天室数量，最大值是 500。
查询聊天室成员是否是在白名单中。
普通成员可查询自己是否在聊天室白名单中；聊天室所有者和管理员可查询其他成员是否在白名单中。
connection.isInChatRoomAllowlist({chatRoomId: 'chatRoomId', userName: 'user1'})
聊天室 ID。
用户 ID。
查询自己是否在聊天室禁言列表中。
connection.isInChatRoomMutelist({chatRoomId: 'chatRoomId'})
聊天室 ID。
加入聊天室。
加入聊天室时携带的扩展字段。
加入聊天室时，是否退出已加入的聊天室。
true：加入该聊天室时，退出其他聊天室。false：加入该聊天室时，不退出其他聊天室。加入聊天室的原因。该参数未启用，可以忽略。
聊天室的 ID。
退出聊天室。
聊天室 ID。
分页列出聊天室的所有成员。
connection.listChatRoomMembers({pageNum: 1, pageSize: 20, chatRoomId: 'chatRoomId'})
聊天室 ID。
当前页码，从 1 开始。
每页期望返回的成员数,最大值为 1,000。
修改聊天室详情。
connection.modifyChatRoom({chatRoomId: 'chatRoomId', chatRoomName: 'chatRoomName', description: 'description', maxusers: 5000})
聊天室 ID。
聊天室名称。
聊天室描述。
聊天室最大成员数。
禁止聊天室用户发言。
聊天室 ID。
禁言时长，单位为毫秒，如果是 -1 代表永久。
被禁言的聊天室成员。
移除聊天室管理员。
聊天室 ID。
被移除管理员权限的用户。
移除聊天室白名单成员。仅聊天室所有者和管理员有权限调用该方法。被移出白名单的成员会在 onChatroomEvent 的回调里收到 "operation:'removeAllowlistMember'" 回调。
connection.removeChatRoomAllowlistMember({chatRoomId: 'chatRoomId', userName: 'user1'})
聊天室 ID。
要移出白名单的成员列表。
移除单个聊天室自定义属性。
connection.removeChatRoomAttributes({chatRoomId: 'chatRoomId', attributeKeys: ['string1','string2'], isForced: boolean })
删除的属性 key。
聊天室 ID。
是否允许一个成员更新其他成员设置的聊天室属性。
true：是；false：否。批量移除聊天室自定义属性。
connection.removeChatRoomAttributes({chatRoomId: 'chatRoomId', attributeKeys: ['attributeKey1','attributeKey2'], isForced: false })
要删除的属性 key 列表。一次删除数量不能超过 10 个。
聊天室 ID。
是否允许成员更新其他成员设置的聊天室自定义属性。
true：是；false：否。移除单个聊天室成员。
connection.removeChatRoomMember({chatRoomId: 'chatRoomId', username: 'username'})
聊天室 ID。
要移除的用户 ID。
设置聊天室管理员。
聊天室 ID。
设置为管理员的用户。
设置单个聊天室自定义属性。
connection.setChatRoomAttribute({chatRoomId: 'chatRoomId', attributeKey: "attributeKey1", attributeValue: "attributeValue1", autoDelete: true, isForced: false})
聊天室自定义属性 key，指定属性名。属性名不能超过 128 字符。每个聊天室最多可有 100 个属性。Key 支持以下字符集： • 26 个小写英文字母 a-z； • 26 个大写英文字母 A-Z； • 10 个数字 0-9； • “_”, “-”, “.”。
聊天室自定义属性值。每个属性值不超过 4096 字符，每个应用的聊天室属性总大小不能超过 10 GB。
成员退出时是否删除该聊天室中其设置的所有聊天室自定义属性。
true：是；false：否。聊天室 ID。
是否允许成员更新其他成员设置的聊天室自定义属性。
true：是；false：否。批量设置聊天室属性。
connection.setChatRoomAttributes({chatRoomId: 'chatRoomId', attributes: {"attributeKey1": "attributeValue1"}, autoDelete: true, isForced: false})
自定义属性集合。
成员退出时是否删除该聊天室中其设定的所有聊天室自定义属性。- （默认）true: 是。- false：否。
聊天室 ID。
是否允许成员更新其他成员设置的聊天室自定义属性。- true: 是。- （默认）false：否。
将单个成员从聊天室黑名单移除。
聊天室 ID。
用户 ID。
批量将成员从聊天室黑名单移除。该方法只有聊天室所有者和管理员才有权限调用。
connection.unblockChatRoomMembers({chatRoomId: 'chatRoomId', usernames: ['user1', 'user2']})
聊天室 ID。
要移除聊天室黑名单的成员数组。
解除对聊天室用户的禁言。
该方法只有聊天室所有者和管理员才有权限调用。该成员和其他未做操作的群管理员或者群主会在 onChatroomEvent 的回调里收到 "operation: 'unmuteMember'"。
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。
上传取消的回调。
上传完成的回调。
上传失败的回调。
上传进度的回调。
Generated using TypeDoc
Chatroom contains APIs for chatroom-related operations.