移除成员

更新时间: 2024/09/09 10:43:28

本文介绍通过 NERoom SDK 实现移除成员(即踢出房间)功能的方法。移除成员后,该用户无法再收发消息、推流、拉流等。

功能介绍

内容安全审核时,如果发现某个用户的内容违规,管理员和主播可以通过本接口将该用户踢出房间。

功能原理

移除成员时,NERoom Server 会根据模板 ID 和角色 ID 查看该角色是否具备相应操作的权限。例如:角色 ID 为 host 的用户,执行移除成员时,权限校验的流程如下图所示。

移除成员的功能原理.png

注意事项

您可以在云信控制台上配置某角色是否具备移除成员的权限,只有具备该权限的角色才可以执行此操作。

配置步骤

  1. 调用 joinRoom 接口加入房间。

  2. 调用 getRoomContext 接口获取房间上下文。

    调用此方法时,您需要将 roomUuid 设置为您所加入房间的 ID。

  3. 调用 NERoomContextkickMemberOut 方法,将成员从房间移除。

    NEKickMemberOutParams 相关参数说明如下表所示。

    名称 描述
    userUuid 待移除用户的 ID。
    用户 ID 只能填一个。

示例代码

/**
 * 获取房间上下文NERoomContext
 * @param roomUuid 房间ID
 */
const NERoomContext = NERoomService.getRoomContext(roomUuid)

/**
 * 移除成员
 * @param userUuid 用户ID
 */
NERoomContext.kickMemberOut(userUuid).then(res => {
    console.log(res, 'kickMemberOut success')
}).catch(err => {
    console.error(err, 'kickMemberOut fail')
})

API 参考

方法 功能描述
kickMemberOut 移除成员
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • 功能原理
  • 注意事项
  • 配置步骤
  • 示例代码
  • API 参考