Class ChatRoom

绑定固定 chatRoomId 的单聊天室上下文对象。

Constructors

constructor

Properties

chatRoomId

Methods

getInfo refresh updateInfo leaveChatRoom getMembers removeMembers getAdminList addAdmin removeAdmin getMuteList muteMembers unmuteMembers muteAllMembers unmuteAllMembers checkIfInMuteList getBlocklist blockMembers unblockMembers getAllowlist addUsersToAllowlist removeUsersFromAllowlist checkIfInAllowList getAnnouncement updateAnnouncement getAttributes setAttributes removeAttributes

Constructors

constructor

Properties

ReadonlychatRoomId

chatRoomId: string

Methods

getInfo

  • getInfo(): Promise<ChatRoomDetail>

    获取当前聊天室详情。

    Returns Promise<ChatRoomDetail>

    返回聊天室详情、公告、权限与当前用户状态。

    Example: 调用示例（获取详情）

    const chatRoom = client.chatRoomManager.getChatRoom('chatroom-1');
    const detail = await chatRoom.getInfo();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

refresh

  • refresh(): Promise<ChatRoomDetail>

    刷新并返回当前聊天室详情，等价于 getInfo()。

    Returns Promise<ChatRoomDetail>

    返回最新聊天室详情。

    Example: 调用示例（刷新详情）

    const detail = await chatRoom.refresh();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

updateInfo

  • updateInfo(input: ChatRoomUpdateInfoInput): Promise<ChatRoomUpdateResult>

    更新当前聊天室名称、描述或最大成员数。

    Parameters

    Returns Promise<ChatRoomUpdateResult>

    返回各字段是否更新成功。

    Example: 调用示例（更新聊天室信息）

    await chatRoom.updateInfo({ name: 'SDK room' });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：需要聊天室管理员权限 401 使用聊天室 owner/admin 账号重试 否
    110 参数无效：聊天室信息长度或范围超限 403 缩短名称/描述，或传入允许范围内的 maxMembers 否
    110 参数无效：聊天室字段不支持修改 400 仅提交 name、description、maxMembers 等允许修改的字段 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

leaveChatRoom

  • leaveChatRoom(): Promise<void>

    退出当前聊天室。

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（退出聊天室）

    await chatRoom.leaveChatRoom();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getMembers

  • getMembers(query?: CursorPageParams): Promise<ChatRoomMemberListResult>

    获取当前聊天室成员列表。

    Parameters

    • query: CursorPageParams = {}

      游标分页参数；未传时使用服务端默认分页。

    Returns Promise<ChatRoomMemberListResult>

    返回成员列表、游标与是否还有下一页。

    Example: 调用示例（获取成员）

    const members = await chatRoom.getMembers({ pageSize: 20 });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

removeMembers

  • removeMembers(
        input: ChatRoomUserBatchInput,
    ): Promise<ChatRoomMemberActionListResult>

    从当前聊天室移除成员。

    Parameters

    Returns Promise<ChatRoomMemberActionListResult>

    返回每个目标用户的移除结果。

    Example: 调用示例（移除成员）

    const result = await chatRoom.removeMembers({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有移除聊天室成员的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getAdminList

  • getAdminList(): Promise<readonly UserInfo[]>

    获取当前聊天室管理员列表。

    Returns Promise<readonly UserInfo[]>

    返回管理员用户资料列表。

    Example: 调用示例（获取管理员）

    const admins = await chatRoom.getAdminList();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

addAdmin

  • addAdmin(input: ChatRoomAdminInput): Promise<void>

    将用户设置为当前聊天室管理员。

    Parameters

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（添加管理员）

    await chatRoom.addAdmin({ userId: 'user-1' });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：只有聊天室所有者可设置管理员 401 使用聊天室 owner 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否
    204 用户不存在 404 确认 userId 对应用户存在 否

removeAdmin

  • removeAdmin(input: ChatRoomAdminInput): Promise<void>

    移除当前聊天室管理员。

    Parameters

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（移除管理员）

    await chatRoom.removeAdmin({ userId: 'user-1' });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：只有聊天室所有者可移除管理员 401 使用聊天室 owner 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getMuteList

  • getMuteList(page?: ChatRoomPageParams): Promise<readonly ChatRoomMuteEntry[]>

    获取当前聊天室禁言列表。

    Parameters

    • Optionalpage: ChatRoomPageParams

      页码分页参数；未传时使用服务端默认分页。

    Returns Promise<readonly ChatRoomMuteEntry[]>

    返回禁言用户与过期时间列表。

    Example: 调用示例（获取禁言列表）

    const mutes = await chatRoom.getMuteList({ pageNum: 1, pageSize: 20 });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

muteMembers

  • muteMembers(input: ChatRoomMuteMembersInput): Promise<void>

    禁言当前聊天室成员。

    Parameters

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（禁言成员）

    await chatRoom.muteMembers({ userIds: ['user-1'], duration: 3600 });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效：聊天室禁言参数不合法 400 检查 userIds 与 muteDuration，确保传入有效值 否
    210 用户无权限：没有禁言聊天室成员的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

unmuteMembers

  • unmuteMembers(input: ChatRoomUserBatchInput): Promise<void>

    解除当前聊天室成员禁言。

    Parameters

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（解除禁言）

    await chatRoom.unmuteMembers({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有解除聊天室成员禁言的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

muteAllMembers

  • muteAllMembers(): Promise<void>

    开启当前聊天室全员禁言。

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（开启全员禁言）

    await chatRoom.muteAllMembers();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有开启全员禁言的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

unmuteAllMembers

  • unmuteAllMembers(): Promise<void>

    关闭当前聊天室全员禁言。

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（关闭全员禁言）

    await chatRoom.unmuteAllMembers();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有关闭全员禁言的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

checkIfInMuteList

  • checkIfInMuteList(): Promise<ChatRoomMuteStatus>

    查询当前用户是否在当前聊天室禁言列表中。

    Returns Promise<ChatRoomMuteStatus>

    返回当前用户是否被禁言及过期时间。

    Example: 调用示例（查询禁言状态）

    const status = await chatRoom.checkIfInMuteList();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getBlocklist

  • getBlocklist(
        page?: ChatRoomPageParams,
    ): Promise<readonly ChatRoomBlocklistEntry[]>

    获取当前聊天室黑名单。

    Parameters

    • Optionalpage: ChatRoomPageParams

      页码分页参数；未传时使用服务端默认分页。

    Returns Promise<readonly ChatRoomBlocklistEntry[]>

    返回黑名单用户列表。

    Example: 调用示例（获取黑名单）

    const blocklist = await chatRoom.getBlocklist({ pageNum: 1, pageSize: 20 });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

blockMembers

  • blockMembers(
        input: ChatRoomUserBatchInput,
    ): Promise<ChatRoomMemberActionListResult>

    将成员加入当前聊天室黑名单。

    Parameters

    Returns Promise<ChatRoomMemberActionListResult>

    返回每个目标用户的拉黑结果。

    Example: 调用示例（拉黑成员）

    const result = await chatRoom.blockMembers({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有添加聊天室黑名单的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否
    204 用户不存在 404 确认 userIds 中的用户都已存在 否

unblockMembers

  • unblockMembers(
        input: ChatRoomUserBatchInput,
    ): Promise<ChatRoomMemberActionListResult>

    从当前聊天室黑名单移除成员。

    Parameters

    Returns Promise<ChatRoomMemberActionListResult>

    返回每个目标用户的移除结果。

    Example: 调用示例（移除黑名单）

    const result = await chatRoom.unblockMembers({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有移除聊天室黑名单的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getAllowlist

  • getAllowlist(): Promise<readonly { user: UserInfo }[]>

    获取当前聊天室 allowlist。

    Returns Promise<readonly { user: UserInfo }[]>

    返回 allowlist 用户列表。

    Example: 调用示例（获取 allowlist）

    const allowlist = await chatRoom.getAllowlist();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

addUsersToAllowlist

  • addUsersToAllowlist(
        input: ChatRoomUserBatchInput,
    ): Promise<ChatRoomMemberActionListResult>

    将用户加入当前聊天室 allowlist。

    Parameters

    Returns Promise<ChatRoomMemberActionListResult>

    返回每个目标用户的添加结果。

    Example: 调用示例（添加 allowlist）

    const result = await chatRoom.addUsersToAllowlist({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有添加聊天室 allowlist 的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否
    204 用户不存在 404 确认 userIds 中的用户都已存在 否

removeUsersFromAllowlist

  • removeUsersFromAllowlist(
        input: ChatRoomUserBatchInput,
    ): Promise<ChatRoomMemberActionListResult>

    从当前聊天室 allowlist 移除用户。

    Parameters

    Returns Promise<ChatRoomMemberActionListResult>

    返回每个目标用户的移除结果。

    Example: 调用示例（移除 allowlist）

    const result = await chatRoom.removeUsersFromAllowlist({ userIds: ['user-1'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：没有移除聊天室 allowlist 的权限 401 使用聊天室 owner/admin 账号重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

checkIfInAllowList

  • checkIfInAllowList(): Promise<boolean>

    查询当前用户是否在当前聊天室 allowlist 中。

    Returns Promise<boolean>

    返回当前用户是否在白名单中。

    Example: 调用示例（查询 allowlist 状态）

    const status = await chatRoom.checkIfInAllowList();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getAnnouncement

  • getAnnouncement(): Promise<ChatRoomAnnouncement>

    获取当前聊天室公告。

    Returns Promise<ChatRoomAnnouncement>

    返回聊天室 ID 与公告内容。

    Example: 调用示例（获取公告）

    const announcement = await chatRoom.getAnnouncement();

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

updateAnnouncement

  • updateAnnouncement(input: ChatRoomAnnouncementUpdateInput): Promise<void>

    更新当前聊天室公告。

    Parameters

    Returns Promise<void>

    成功时无返回业务数据。

    Example: 调用示例（更新公告）

    await chatRoom.updateAnnouncement({ announcement: 'Welcome' });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    210 用户无权限：需要聊天室管理员权限 401 使用聊天室 owner/admin 账号重试 否
    110 参数无效：聊天室公告长度超限 403 缩短公告内容后重试 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

getAttributes

  • getAttributes(
        input?: GetChatRoomAttributesInput,
    ): Promise<ChatRoomAttributesSnapshot>

    获取当前聊天室属性。

    Parameters

    Returns Promise<ChatRoomAttributesSnapshot>

    返回聊天室属性快照。

    Example: 调用示例（获取属性）

    const snapshot = await chatRoom.getAttributes({ keys: ['topic'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效：属性 key 列表不合法 400 确保 keys 为合法非空字符串数组，或省略 keys 获取全部属性 否
    705 聊天室不存在 404 确认 chatRoomId 正确且聊天室仍存在 否

setAttributes

  • setAttributes(
        input: SetChatRoomAttributesInput,
    ): Promise<ChatRoomAttributeMutationResult>

    设置当前聊天室属性。

    Parameters

    Returns Promise<ChatRoomAttributeMutationResult>

    返回成功应用和失败的属性 key。

    Example: 调用示例（设置属性）

    const result = await chatRoom.setAttributes({
      attributes: { topic: 'sdk' },
      autoDelete: true,
    });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效：聊天室属性数量或字段不合法 400 确保每次设置的属性数量不超过限制，且 key/value 均为合法字符串 否
    702 未加入聊天室 400 先加入聊天室后重试 否
    703 聊天室属性权限拒绝 400 仅修改自己创建的属性，或使用 forced 模式覆盖 否
    4 聊天室属性数量或总量超限 400 删除不再使用的属性后重试，或联系服务端提升配额 否
    210 用户无权限：聊天室属性写入被拒绝 401 确认当前用户已加入聊天室，并仅修改自己有权限操作的属性 否

removeAttributes

  • removeAttributes(
        input: RemoveChatRoomAttributesInput,
    ): Promise<ChatRoomAttributeMutationResult>

    删除当前聊天室属性。

    Parameters

    Returns Promise<ChatRoomAttributeMutationResult>

    返回成功删除和失败的属性 key。

    Example: 调用示例（删除属性）

    const result = await chatRoom.removeAttributes({ keys: ['topic'] });

    可能出现的错误码

    Code 含义 HTTP 处理建议 可重试
    110 参数无效：聊天室属性 key 列表不合法 400 确保每次删除的属性数量不超过限制，且 keys 为合法非空字符串数组 否
    702 未加入聊天室 400 先加入聊天室后重试 否
    703 聊天室属性权限拒绝 400 仅删除自己创建的属性，或使用 forced 模式 否
    4 聊天室属性操作超限 400 减少单次操作的属性数量 否
    210 用户无权限：聊天室属性删除被拒绝 401 确认当前用户已加入聊天室，并仅删除自己有权限操作的属性 否

Settings

Member Visibility

On This Page

Constructors
Properties
Methods
getInforefreshupdateInfoleaveChatRoomgetMembersremoveMembersgetAdminListaddAdminremoveAdmingetMuteListmuteMembersunmuteMembersmuteAllMembersunmuteAllMemberscheckIfInMuteListgetBlocklistblockMembersunblockMembersgetAllowlistaddUsersToAllowlistremoveUsersFromAllowlistcheckIfInAllowListgetAnnouncementupdateAnnouncementgetAttributessetAttributesremoveAttributes