Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChatroomMemberServiceInterface

调用方式:

chatroom.chatroomMember.updateMyRoomRole(options)

Hierarchy

  • ChatroomMemberServiceInterface

Index

Methods

Methods

kickMember

  • 踢聊天室成员

    影响范围
    • 被踢出成员收到 ChatroomEventInterface.kicked 事件通知，并退出聊天室
    • 聊天室其它成员收到类型为 attach.type = kickMember 的聊天室通知消息
    example
    chatroom.chatroomMember.kickMember({
       account: 'account'
    })

    chatroom.on('kicked', () => {
      console.log('kicked')
    })

    chatroom.on('chatroomMsg', (msg) => {
       // kickMember
       console.log(msg.attach.type)
    })

    Parameters

    Returns Promise<void>

queryMembers

  • 根据时间戳分页查询聊天室的成员。

    共有四种查询模式：

    • regular: 聊天室固定成员，包括创建者，管理员，普通等级用户，受限用户（禁言+黑名单），有数量上限
    • temp: 聊天室非固定成员，只有在线时才能在列表中看到，数量无上限
    • regularOnline: 聊天室在线的固定成员
    • regularReverse: 聊天室非固定成员（反向查询）

    通过 chatroom.chatroomMember.setMemberNormal 设置成员为固定成员

    example
    const members = await chatroom.chatroomMember.queryMembers({
       type: 'regular',
       limit: 100
    })

    Parameters

    Returns Promise<ChatroomMember[]>

queryMembersByAccounts

  • 根据 accounts 获取聊天室成员。只有在线成员，或者固定成员才会返回

    example
    const members = await chatroom.chatroomMember.queryMembersByAccounts({
      accounts: ['account1', 'account2']
    })

    Parameters

    Returns Promise<ChatroomMember[]>

queryMembersByTag

queryMembersCountByTag

setMemberBlackList

  • 设置聊天室黑名单账号。

    影响范围
    • 被加入黑名单账号无法加入聊天室。移除黑名单后，用户可以重新进入聊天室
    • 在线用户被加入黑名单后会被踢出聊天室，并收到 ChatroomEventInterface.kicked 事件通知
    • 聊天室其它成员收到类型为 attach.type = blackMember 的聊天室通知消息
    • 移除黑名单时，聊天室其它成员收到类型为 attach.type = unblackMember 的聊天室通知消息
    example
    chatroom.chatroomMember.setMemberBlackList({
      account: 'account'
      isAdd: true
    })

    Parameters

    Returns Promise<ChatroomMember>

setMemberManager

  • 设置聊天室管理员

    影响范围
    • 管理员可以设置聊天室普通成员, 设置聊天室黑名单, 设置聊天室禁言名单, 踢聊天室成员
    • 添加管理员时，聊天室成员收到 attach.type = addManager 的聊天室通知消息
    • 移除管理员时，聊天室成员收到 attach.type = removeManager 的聊天室通知消息
    example
    chatroom.chatroomMember.setMemberManager({
      account: 'account'
      isAdd: true
    })

    Parameters

    Returns Promise<ChatroomMember>

setMemberMute

  • 设置聊天室禁言

    影响范围
    • 被加入禁言名单的人将不能在该聊天室发送消息
    • 聊天室成员收到类型为 attach.type = gagMember 的聊天室通知消息
    • 移除禁言名单时，聊天室成员收到类型为 attach.type = ungagMember 的聊天室通知消息

    Parameters

    Returns Promise<ChatroomMember>

setMemberNormal

  • 设置聊天室普通成员

    影响范围
    • 聊天室成员收到类型为 attach.type = addCommon 的聊天室通知消息
    • 移除普通成员时，聊天室成员收到类型为 attach.type = removeCommon 的聊天室通知消息

    Parameters

    Returns Promise<ChatroomMember>

setMemberTempMute

  • 设置聊天室临时禁言。临时禁言可以以秒为单位设置。

    如果需要解除禁言，可以调用 setMemberTempMute，并将 duration 设置为 0

    影响范围
    • 聊天室成员会收到类型为 attach.type = addTempMute 的聊天室通知消息
    • 解除禁言时，聊天室成员会收到类型为 attach.type = removeTempMute 的聊天室通知消息

    Parameters

    Returns Promise<void>

setMembersTempMuteByTag

  • 根据tag设置聊天室临时禁言。临时禁言可以以秒为单位设置。

    如果需要解除禁言，可以调用 setMembersTempMuteByTag，并将 duration 设置为 0

    影响范围
    • 聊天室成员会收到类型为 attach.type = addTempMuteTag 的聊天室通知消息
    • 解除禁言时，聊天室成员会收到类型为 attach.type = removeTempMuteTag 的聊天室通知消息

    Parameters

    Returns Promise<void>

updateMyRoomRole

  • 更新自己在聊天室中的信息

    影响范围
    • 更新自己的信息，聊天室成员收到类型为 attach.type = updateMemberInfo 的聊天室通知消息
    example
    chatroom.chatroomMember.updateMyRoomRole({
       member: {
         nick: 'myNickName'
       },
       needNotify: true
    })

    Parameters

    Returns Promise<void>