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 端推送问题排查
第三方推送厂商的限制说明
服务协议

圈组系统通知收发

更新时间: 2022/12/12 10:42:09

圈组系统通知是用户在使用圈组功能的过程中,由云信 IM 下发给用户相关事件的通知,比如圈组服务器中的成员变更,频道变更等事件。

功能介绍

圈组内置系统通知只能通过具体事件触发,由云信 IM 发送给相关的圈组用户。用户只需注册圈组系统通知的相关监听,就能接收到对应的系统通知。

圈组自定义系统通知支持用户主动发送,并可以指定发送给全员或部分成员。

云信 IM Android SDK 的 QChatMessageService 接口提供管理圈组系统通知的相关方法,QChatServiceObserver 接口提供监听圈组系统通知的相关方法,帮助您快速实现对圈组系统通知的管理。

NIM SDK 中的 QChatSystemNotification 类定义了圈组的系统通知,其内置方法如下:

单击展开查看 QChatSystemNotification 的内置方法
返回值类型 内置方法 说明
String getAttach() 系统通知附件
QChatSystemNotificationAttachment getAttachment() 系统通知附件字符串解析后的结构
String getBody() 系统通知内容
String getCallbackExtension() 获取第三方回调的自定义扩展字段
long getChannelId() 系统通知所属的频道的 ID
String getEnv() 获取环境变量,用于指向不同的抄送,第三方回调等配置
String getExtension() 扩展字段
String getFromAccount() 系统通知发送者的 accid
int getFromClientType() 系统通知发送者的客户端类型
String getFromDeviceId() 发送方设备 ID
String getFromNick() 发送方昵称
String getMsgIdClient() 客户端生成的系统通知 ID,用于去重
long getMsgIdServer() 服务器生成的系统通知 ID,全局唯一
String getPushContent() 自定义推送文案
String getPushPayload() 第三方自定义的推送属性,限制使用 JSON 格式
int getRawType() 获取通知类型裸数据,可能是新增通知类型,但是SDK还未更新,枚举还未添加
long getServerId() 系统通知所属的圈组服务器的 ID
int getStatus() 系统通知状态,可自定义。默认为 0,大于 10,000 为用户自定义的状态
long getTime() 系统通知发送时间
List getToAccids() 系统通知接收者账号列表
QChatSystemMessageToType getToType() 系统通知发送对象类型。主要分为服务器,服务器成员,频道,频道成员
QChatSystemNotificationType getType() 系统通知类型,具体系统通知类型的接收条件等信息,可参考服务器的 QChatSystemMsgType
long getUpdateTime() 系统通知更新时间
boolean isNeedBadge() 是否需要消息计数
boolean isNeedPushNick() 是否需要推送昵称
boolean isPersistEnable() 是否存离线,只有toAccids不为空,才能设置为存离线
boolean isPushEnable() 是否需要推送,默认 false
boolean isRouteEnable() 是否需要抄送,默认 true
void setEnv(String env) 设置环境变量,用于指向不同的抄送,第三方回调等配置

实现方法

本文以服务器所有者(即创建者)和服务器成员的交互为例,介绍服务器所有者发送圈组自定义系统通知的实现流程和触发内置圈组系统通知的实现流程。

前提条件

  • 接入圈组,并已创建圈组服务器。
  • 创建云信 IM 账号,作为下文中服务器所有者和服务器成员的云信 IM 账号。

如果用户所在服务器的成员人数超过 2000 人阈值,该用户还需先订阅相应的服务器或频道,才能收到对应服务器或频道的系统通知。如未超过该阈值,则无需订阅。订阅相关说明,请参见圈组订阅机制

实现流程

uml diagram

以下只对部分重要步骤进行说明:

  1. 服务器成员注册 observeReceiveSystemNotification 监听圈组系统通知的接收。

    示例代码:

    NIMClient.getService(QChatServiceObserver.class).observeReceiveSystemNotification(new Observer<List<QChatSystemNotification>>() {
    @Override
    public void onEvent(List<QChatSystemNotification> qChatSystemNotifications) {
    //收到圈组系统通知
    for (QChatSystemNotification qChatSystemNotification : qChatSystemNotifications) {
    //处理圈组系统通知
    }
    }
    }, true);
    
  2. 服务器所有者通过调用 sendSystemNotification 发送圈组自定义系统通知。

    其中 QChatSendSystemNotificationParam 是发送圈组自定义系统通知入参,提供四种构造方法,通过入参的不同来进行区分,通知给不同的对象:

    通知的对象 涉及的入参
    通知给圈组服务器全员 serverId(服务器 ID)
    通知给圈组服务器中的某个频道全员 serverId(服务器 ID),channelId(频道 ID)
    通知给圈组服务器中的部分成员 serverId(服务器 ID),toAccids(通知的服务器成员列表)
    通知给圈组服务器中的某个频道中的部分成员 serverId(服务器 ID),channelId(频道 ID),toAccids(通知的频道成员列表)

    若需要在发送自定义系统通知前提前构造一个 QChatSystemNotification,您可以通过 QChatSendSystemNotificationParamtoSystemNotification 构造圈组自定义系统通知。

    示例代码:

    QChatSendSystemNotificationParam param = new QChatSendSystemNotificationParam(943445L,885305L);
    param.setBody("测试自定义系统通知");
    param.setExtension(getExtension());
    param.setPushPayload(getPushPayload());
    param.setPushContent("测试推送自定义系统通知");
    param.setPushEnable(true);
    param.setNeedBadge(true);
    param.setNeedPushNick(true);
    
    QChatSystemNotification currentSystemNotification = param.toSystemNotification();
    
    NIMClient.getService(QChatMessageService.class).sendSystemNotification(param).setCallback(new RequestCallback<QChatSendSystemNotificationResult>() {
    @Override
    public void onSuccess(QChatSendSystemNotificationResult result) {
    //发送自定义系统通知成功,返回发送成功的自定义系统通知具体信息
            QChatSystemNotification notification = result.getSentCustomNotification();
    }
    
    @Override
    public void onFailed(int code) {
    //发送自定义系统通知息失败,返回错误code
    }
    
    @Override
    public void onException(Throwable exception) {
    //发送自定义系统通知异常
    }
    });
    
  3. 服务器成员收到来自服务器所有者的自定义系统通知。

  4. 服务器成员通过调用 markSystemNotificationsRead 标记圈组系统通知已读。

    标记已读后的系统通知将从服务端删除,后续不会在其他端接收。

    示例代码:

    QChatSystemNotification systemNotification = getMarkSystemNotification();
    List<Pair<Long, QChatSystemNotificationType>> pairs = new ArrayList<>();
    pairs.add(new Pair<>(systemNotification.getMsgIdServer(),systemNotification.getType()));
    
    QChatMarkSystemNotificationsReadParam param = new QChatMarkSystemNotificationsReadParam(pairs);
    NIMClient.getService(QChatMessageService.class).markSystemNotificationsRead(param).setCallback(new RequestCallback<Void>() {
        @Override
        public void onSuccess(Void result) {
            //标记成功
        }
    
        @Override
        public void onFailed(int code) {
            //标记失败
        }
    
        @Override
        public void onException(Throwable exception) {
            //标记异常
        }
    });
    
  5. 服务器所有者调用 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异常
                }
            });
    
    
  6. 服务器所有者和服务器成员收到系统投递的内置系统通知。

    该示例收到类型为“删除服务器”的系统通知,更多事件类型和相应的通知接收条件,请参见圈组系统通知分类圈组系统通知接收机制

  7. (可选)如果因为网络等原因,自定义系统通知发送失败,用户可以调用 resendSystemNotification 方法重新发送自定义系统通知。

    如果重发已经发送成功的自定义系统通知,那么通知接收方不会再次收到该系统通知。

    示例代码:

    NIMClient.getService(QChatMessageService.class).resendSystemNotification(new QChatResendSystemNotificationParam(currentSystemNotification)).setCallback(new RequestCallback<QChatSendSystemNotificationResult>() {
        @Override
        public void onSuccess(QChatSendSystemNotificationResult result) {
            //重发自定义系统通知成功,返回发送成功的自定义系统通知具体信息
            QChatSystemNotification notification = result.getSentCustomNotification();
        }
    
        @Override
        public void onFailed(int code) {
            //重发自定义系统通知息失败,返回错误code
        }
    
        @Override
        public void onException(Throwable exception) {
            //重发自定义系统通知异常
        }
    });
    

API 参考

API 说明
observeReceiveSystemNotification 监听圈组系统通知的接收
sendSystemNotification 发送圈组自定义系统通知
markSystemNotificationsRead 标记圈组系统通知已读
deleteServer 删除圈组服务器
resendSystemNotification 重新发送自定义系统通知
此文档是否对你有帮助?
有帮助
我要吐槽
  • 功能介绍
  • 实现方法
  • 前提条件
  • 实现流程
  • API 参考