删除房间
更新时间: 2024/09/09 10:40:48
本文介绍通过 NERoom SDK 实现删除房间功能的方法。删除房间后,房间内所有成员被移出房间。
注意事项
- PK 直播房间的保留时长最多为 24 小时,超过 24 小时,NERoom Server会自动删除该房间。
- 其他业务场景中,房间的保留时长最多为 16 小时,超过 16 小时,NERoom Server会自动删除该房间。
- 如果您需要延长默认的房间保留时长,请联系网易云信商务经理。
- 您可以在云信控制台上配置某角色是否具备删除房间的权限,只有具备该权限的角色才可以执行此操作。
功能原理
用户在删除房间时,NERoom Server 会根据模板 ID 和角色 ID 查看该角色是否具备相应操作的权限。例如:角色 ID 为 host 的用户,执行删除房间时,权限校验的流程如下图所示。
配置步骤
-
调用
getRoomContext
方法获取房间上下文。调用此方法时,您需要将
roomUuid
设置为您所加入房间的 ID。 -
调用
endRoom
接口删除房间。删除房间成功后,会触发
NERoomListener
协议中的onRoomEnded
回调方法。
示例代码
实现删除房间功能的示例代码如下:
/**
* @param roomUuid 房间ID
*/
const NERoomContext = NERoomService.getRoomContext(roomUuid)
NERoomContext.endRoom().then(() => {
console.log('endRoom success')
}).catch(err => {
console.error(err, 'endRoom fail')
})
相关API文档
方法 | 功能描述 |
---|---|
endRoom | 删除房间 |
此文档是否对你有帮助?