IM 即时通讯
Android
动态与公告
IM UIKit 更新日志
NIM SDK 开发版更新日志
NIM SDK 稳定版更新日志
新手接入指南
产品介绍
简介
主要功能
产品优势
功能介绍
账号集成与登录
多端登录与互踢策略
群组功能
聊天室功能
聊天室标签功能
圈组功能
质量数据监控台
海外数据中心
IM平滑迁移方案
接口及业务限制
体验 Demo
下载 SDK 与 Demo 源码
快速开始
跑通 IM Demo 源码
实现单聊消息收发(不含 UI)
跑通圈组 Demo 源码
实现圈组消息收发(不含 UI)
含 UI 集成
什么是 IM UIKit
IM UIKit 功能概览
快速集成 IM UIKit
组件导入
初始化
界面跳转
自定义用户信息
全局配置
会话列表相关
集成会话列表界面
会话列表事件监听
自定义会话列表界面 UI
会话列表 API 概览
会话消息相关
集成会话界面
会话界面事件监听
实现音视频通话
实现地理位置消息功能(含 UI)
实现自定义消息发送(含 UI)
自定义会话界面 UI
会话消息 API 概览
通讯录相关
集成通讯录界面
自定义通讯录界面 UI
通讯录界面事件监听
通讯录 API 概览
UIKit 功能实现方案
消息回复实现方案
UIKit 版本升级说明
系统兼容相关
IM UIKit 常见问题排查
IM UIKit API 概览
不含 UI 集成
使用说明
集成 SDK
初始化
登录相关
登录 IM
多端登录与互踢
登出 IM
消息相关
消息概述
消息收发
自定义消息收发
消息配置选项
NOS 存储场景
广播消息收发
消息已读回执
消息撤回
消息重发与转发
消息更新
消息过滤
语音消息处理
插入本地消息
历史消息
最近会话
服务端会话服务
用户资料
用户关系
在线状态订阅
系统通知
系统通知概述
内置系统通知管理
内置系统通知未读数
自定义系统通知收发
Android 离线推送
实现离线推送
配置消息的推送属性
设置群消息强制推送
设置推送全局免打扰
设置多端推送策略
集成小米推送
集成华为推送
集成荣耀推送
集成 OPPO 推送
集成 vivo 推送
集成魅族推送
集成谷歌推送(FCM)
消息提醒
实现消息提醒
配置消息提醒功能
设置群消息强制提醒
设置消息提醒文案
定制通知栏显示信息
群组功能
群组概述
群组管理
群成员管理
群消息管理
超大群功能
聊天室
圈组功能
圈组概述
登录管理
服务器相关
服务器概述
服务器管理
服务器成员管理
游客功能
服务器未读数管理
频道相关
频道概述
频道管理
频道黑白名单
实时互动频道
频道分组
频道分组黑白名单
频道未读数管理
搜索服务器和频道
身份组相关
身份组概述
身份组应用场景
服务器身份组
频道身份组
用户定制权限
频道分组身份组
自定义权限项
成员权限查询与判定
身份组相关查询
圈组订阅机制
圈组消息相关
图解圈组消息流转
圈组消息收发
消息发送配置项
圈组消息撤回
圈组消息更新
圈组消息删除
消息正在输入
会话消息回复(Thread)
圈组快捷评论
获取频道最后一条消息
查询历史消息
查询@我的消息
圈组消息缓存
圈组消息搜索
圈组系统通知相关
圈组系统通知概述
圈组系统通知收发
圈组系统通知更新
圈组离线推送
圈组内容审核
圈组相关抄送
圈组第三方回调
圈组各端接口命名差异
反垃圾(内容审核)
聊天扩展
其他
最佳实践
IM 登录最佳实践
IM 应用隐私合规
聊天室重要消息投递
API 参考
Android SDK API
Android SDK 状态码/错误码
IM 控制台指南
创建应用
注册 IM 账号
升级服务
开通聊天室功能
配置应用客户端标识
添加推送证书
常见问题
FAQ
错题集
Android 端推送问题排查
第三方推送厂商的限制说明
服务协议

服务器管理

更新时间: 2023/03/07 19:04:16

NIM SDK 的QChatServerService类提供管理服务器的相关方法,支持圈组服务器的创建、修改和删除。

前提条件

使用限制

单个用户的服务器的数量上限(包括自己创建的和加入的)默认为 100 个。

可在云信控制台配置单个用户的服务器数量上限在云信控制台选择应用,进入IM 免费版/专业版 > 功能权限开通 > 拓展配置 > 圈组 > 高级配置 > 单个用户server数即可配置。

实现方法

创建服务器

调用createServer方法可创建一个服务器。

示例代码如下:

QChatCreateServerParam param = new QChatCreateServerParam("测试");
QChatAntiSpamConfig antiSpamConfig = new QChatAntiSpamConfig("用户配置的对某些资料内容另外的反垃圾的业务ID");
param.setAntiSpamBusinessId(antiSpamConfig);
NIMClient.getService(QChatServerService.class).createServer(param).setCallback(
        new RequestCallback<QChatCreateServerResult>() {
            @Override
            public void onSuccess(QChatCreateServerResult result) {
                // 创建成功
                QChatServer server = result.getServer();
            }

            @Override
            public void onFailed(int code) {
                // 创建失败,返回错误code
            }

            @Override
            public void onException(Throwable exception) {
                // 创建异常
                     }
        });

上述示例代码中的antiSpamConfig为圈组内容审核配置,详情请参见圈组内容审核

修改服务器

调用updateServer方法可修改服务器的配置信息,包括服务器名称、服务器图标、服务器自定义扩展、服务器邀请模式和服务器申请模式等。

调用该方法需要拥有“管理服务器”的权限(QChatRoleResource.MANAGE_SERVER)。权限通过身份组进行配置和管理,具体请参见身份组概述及其他身份组相关文档。


示例代码如下:

QChatUpdateServerParam param = new QChatUpdateServerParam(944335L);
param.setName("修改Server名称");
QChatAntiSpamConfig antiSpamConfig = new QChatAntiSpamConfig("用户配置的对某些资料内容另外的反垃圾的业务ID");
param.setAntiSpamBusinessId(antiSpamConfig);
NIMClient.getService(QChatServerService.class).updateServer(param).setCallback(
        new RequestCallback<QChatUpdateServerResult>() {
            @Override
            public void onSuccess(QChatUpdateServerResult result) {
                // 修改Server信息成功
                QChatServer server = result.getServer();
            }

            @Override
            public void onFailed(int code) {
                // 修改Server信息失败,返回错误code
            }

            @Override
            public void onException(Throwable exception) {
                // 修改Server信息异常
            }
        });

删除服务器

服务器创建者可调用deleteServer方法将自己创建的某个服务器删除。

仅服务器创建者可删除服务器。


示例代码如下:

NIMClient.getService(QChatServerService.class).deleteServer(new QChatDeleteServerParam(944335L)).setCallback(
        new RequestCallback<Void>() {
            @Override
            public void onSuccess(Void result) {
                // 删除Server成功
            }

            @Override
            public void onFailed(int code) {
                //  删除Server失败,返回错误code
            }

            @Override
            public void onException(Throwable exception) {
                //  删除Server异常
            }
        });

查询服务器

分页查询服务器列表

用户登录圈组后,如果想要获取当前圈组内已有的服务器,可调用getServersByPage方法,通过时间戳和查询数量分页查询服务器列表。调用时可通过Future<NIMResult<QChatGetServersByPageResult>> 可设置回调函数,监听操作结果。如果调用成功,回调返回查询到的服务器列表。

示例代码如下:

//当前时间往前查最多100条Server信息
NIMClient.getService(QChatServerService.class).getServersByPage(new QChatGetServersByPageParam(System.currentTimeMillis(),100)).setCallback(
        new RequestCallback<QChatGetServersByPageResult>() {
            @Override
            public void onSuccess(QChatGetServersByPageResult result) {
                // 查询Server信息成功
                List<QChatServer> servers = result.getServers();
            }

            @Override
            public void onFailed(int code) {
                // 查询Server信息失败,返回错误code
            }

            @Override
            public void onException(Throwable exception) {
                // 查询Server信息异常
            }
        });

根据服务器ID查询服务器列表

用户登录圈组后,如果需要检索服务器,可调用getServers方法,根据服务器的 ID 查询对应的服务器列表。调用时可通过Future<NIMResult<QChatGetServersResult>>可设置回调函数,监听操作结果。如果调用成功,回调返回查询到的服务器列表。

示例代码如下:

List<Long> serviceIds = new ArrayList<>();
serviceIds.add(944334L);
serviceIds.add(944335L);
NIMClient.getService(QChatServerService.class).getServers(new QChatGetServersParam(serviceIds)).setCallback(
        new RequestCallback<QChatGetServersResult>() {
            @Override
            public void onSuccess(QChatGetServersResult result) {
                // 查询Server信息成功
                List<QChatServer> servers = result.getServers();
            }

            @Override
            public void onFailed(int code) {
                // 查询Server信息失败,返回错误code
            }

            @Override
            public void onException(Throwable exception) {
                // 查询Server信息异常
            }
        });

相关参考

相关系统通知

圈组系统通知的类型在QChatSystemNotificationType枚举中定义,与服务器管理相关的内置系统通知类型如下:

枚举值 说明
SERVER_CREATE 创建服务器
SERVER_REMOVE 删除服务器
SERVER_UPDATE 修改服务器信息

更多圈组系统通知相关说明,请参见圈组系统通知相关

API 调用时序

下图可能因为网络问题显示异常,如显示异常,一般刷新当前页面即可正常显示。

uml diagram

上图中:

相关内容审核

创建或修改服务器时,如果通过setAntiSpamBusinessId方法配置了安全通的业务 ID, 那么云信将会对服务器资料进行“安全通”内容审核。antiSpamBusinessId代表安全通默认内容审核业务以外的自定义内容审核的业务 ID;如需新增自定义内容审核,请联系商务经理进行相关配置,然后前往云信控制台的安全通配置界面获取该业务 ID。

更多圈组内容审核相关说明,参见圈组内容审核

此文档是否对你有帮助?
有帮助
我要吐槽
  • 前提条件
  • 使用限制
  • 实现方法
  • 创建服务器
  • 修改服务器
  • 删除服务器
  • 查询服务器
  • 分页查询服务器列表
  • 根据服务器ID查询服务器列表
  • 相关参考
  • 相关系统通知
  • API 调用时序
  • 相关内容审核