服务器管理
更新时间: 2024/03/14 19:21:14
NIM SDK 的QChatServerServiceInterface
接口类提供管理服务器的相关方法,支持圈组服务器的创建、修改和删除。
前提条件
已登录圈组。
使用限制
单个用户的服务器的数量上限(包括自己创建的和加入的)默认为 100 个。
若需要扩展上限,可在控制台配置圈组子功能项(单个用户 server 数),具体请参考开通和配置圈组功能。
实现方法
创建服务器
调用createServer
方法可创建一个服务器。调用时,可配置是否对传入的服务器资料信息进行内容审核。
示例代码如下:
const qchat = new QChat(options);
qchat.qchatServer.createServer({
"name": "服务器",
"antiSpamBusinessId":{ // 内容审核配置
"textbid":"",
"picbid":""
}
...
})
修改服务器
调用updateServer
方法可修改服务器的配置信息,包括服务器名称、服务器图标、服务器自定义扩展、服务器邀请模式和服务器申请模式等,还可配置是否对修改的服务器资料信息进行内容审核。
调用该方法需要拥有“管理服务器”的权限(QChatRoleAuth.manageServer
)。权限通过身份组进行配置和管理,具体请参见身份组概述及其他身份组相关文档。
示例代码如下:
const qchat = new QChat(options);
qchat.qchatServer.updateServer({
"name": "123456",
})
删除服务器
服务器创建者可调用deleteServer
方法将自己创建的某个服务器删除。
仅服务器创建者可删除服务器。
示例代码如下:
const qchat = new QChat(options);
qchat.qchatServer.deleteServer({
"serverId": "123456",
})
查询服务器
分页查询服务器列表
用户登录圈组后,如果想要获取当前圈组内已有的服务器,可调用getServersByPage
方法,通过时间戳和查询数量分页查询服务器列表。调用时可通过Future<NIMResult<QChatGetServersByPageResult>>
可设置回调函数,监听操作结果。如果调用成功,回调返回查询到的服务器列表。
示例代码如下:
const qchat = new QChat(options);
qchat.qchatServer.getServersByPage({
"timestamp": 0,
"limit":10
})
根据服务器ID查询服务器列表
用户登录圈组后,如果需要检索服务器,可调用getServers
方法,根据服务器的 ID 查询对应的服务器列表。调用时可通过``可设置回调函数,监听操作结果。如果调用成功,回调返回查询到的服务器列表。
示例代码如下:
const qchat = new QChat(options);
qchat.qchatServer.getServersByPage({
"timestamp": 0,
"limit":10
})
服务器资料内容审核
创建或修改服务器时,如果通过AntispamTag
配置了 antiSpamBusinessId
, 那么云信将会对服务器资料进行安全通内容审核。antiSpamBusinessId
代表安全通默认内容审核业务以外的自定义内容审核的业务 ID;如需新增自定义内容审核,请联系商务经理进行相关配置,然后前往云信控制台的安全通配置界面获取该业务 ID。
更多圈组内容审核相关说明,参见圈组内容审核。