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

圈组订阅机制

更新时间: 2022/12/27 17:39:15

一般情况下,圈组内消息与系统通知的接收受订阅机制限制。当用户登录到圈组服务器后,需要先订阅相关频道或者服务器,才能收到相关频道和圈组服务器的消息、事件和系统通知。

本文仅介绍服务器成员的订阅机制。自 v9.8.0起,圈组支持游客订阅服务器和频道,从而实现游客接收消息和部分系统通知,游客的订阅机制与服务器成员的订阅机制互相独立。游客订阅相关说明,请参见游客功能

免除订阅的情况

下列条件下,服务器或频道的成员接收消息和系统通知不受订阅机制限制。

  • 成员数量小于 2,000 (可通过云信官网首页提供的联系方式咨询商务经理调整该阈值)的服务器,即使不订阅,其成员也能收到这些服务器和服务器下所有频道的消息和系统通知。
  • 被@的账号(非@所有人),即使没有订阅也会收到消息。
  • 针对某些成员发送的系统通知(区别于发送给频道内所有人或者服务器内所有人),即使没有订阅这些成员也会收到通知。

订阅方法

订阅圈组服务器

调用subscribeServer:completion:方法即可订阅圈组服务器。该方法的入参结构NIMQChatSubscribeServerParam中需传入订阅类型(具体见下文的订阅类型),订阅操作类型(订阅或取消订阅)和需要订阅的serverId列表。

注意的是,调用该方法时可传入的订阅类型枚举值,仅能为NIMQChatSubscribeTypeServerMsg,即订阅服务器的消息和服务器相关系统通知,如服务器基本信息修改、人员进出、权限变更、创建频道等。

  • 用户所参与事件(即为事件当事人)的系统通知,如被邀请加入服务器、被踢出服务器等,用户不需要订阅也能收到。
  • 用户未参与事件的系统通知,在服务器人数大于默认阈值(2000 人)时,需要用户订阅服务器后,才能收到。 如服务器人数小于默认阈值,用户不订阅服务器,也能收到这类系统通知。
  • 方法原型

    @protocol NIMQChatServerManager <NSObject>
    /**
    * 订阅服务器请求
    *
    * @param param 传入参数
    * @param completion 结果回调
    */
    -(void)subscribeServer:(NIMQChatSubscribeServerParam *)param
                completion:(nullable NIMQChatHandler)completion;
    @end
    
  • 示例代码

    NIMQChatSubscribeServerParam *param = [[NIMQChatSubscribeServerParam alloc] init];
    // 订阅服务器,这里只能传服务器类型的订阅。订阅频道请用其他接口
    param.subscribeType = NIMQChatSubscribeTypeServerMsg;
    param.operationType = NIMQChatSubscribeOperationTypeSubscribe;
    param.targets = @[@(123456)];
    id <NIMQChatServerManager> qchatServerManager = [[NIMSDK sharedSDK] qchatServerManager];
    [qchatServerManager subscribeServer:param
                            completion:^(NSError *error) {
        // your code
    }];
    

订阅频道

调用subscribeChannel:completion:方法即可订阅频道。该方法的入参结构为NIMQChatSubscribeChannelParam,需传入需要传入订阅类型(具体见下文的订阅类型)、订阅操作类型(订阅或取消订阅)和待订阅的serverId+channelId列表。

  • 方法原型

    @protocol NIMQChatChannelManager <NSObject>
    /**
    * 订阅频道
    *  大服务器下,只有订阅频道后才能收到该频道的订阅内容(消息、未读数、未读状态);与你相关的消息不需要订阅频道,就可以收到,比如@你的消息(@All的消息不属于与你相关的消息)
    * 小服务器下,不需要订阅频道就可以收到所有该服务器下所有频道的消息
    * @param param 传入参数
    * @param completion 结果回调
    */
    -(void)subscribeChannel:(NIMQChatSubscribeChannelParam *)param
                completion:(nullable NIMQChatHandler)completion;
    @end
    

    方法原型注释中的“大服务器”指代人数大于默认阈值的服务器,“小服务器”指人数不超过默认阈值的服务器。

  • 示例代码

    id<NIMQChatChannelManager> qchatChannelManager = [[NIMSDK sharedSDK] qchatChannelManager];
    NIMQChatSubscribeChannelParam * param = [[NIMQChatSubscribeChannelParam alloc] init];
    // 订阅频道消息,这里只能传频道类型的订阅。订阅服务器请用其他接口
    param.subscribeType = NIMQChatSubscribeTypeChannelMsg;
    param.operationType = NIMQChatSubscribeOperationTypeSubscribe;
    param.targets = @[@(123456)];
    [qchatChannelManager subscribeChannel:param
                            completion:^(NSError *error) {
        // your code
    }];
    

订阅类型

NIMQChatSubscribeType枚举定义了圈组服务器和频道的订阅类型。各订阅类型说明如下:

枚举值
订阅类型
订阅后接收的信息
NIMQChatSubscribeTypeChannelMsg 订阅某个频道的消息和系统通知,单用户默认最多可订阅 100 个频道。 频道的消息和频道相关系统通知。
NIMQChatSubscribeTypeChannelMsgUnreadCount 订阅某个频道的消息未读数和系统通知,单用户默认最多可订阅 500 个频道。 频道的未读数(默认上限 99)和频道相关系统通知
NIMQChatSubscribeTypeChannelMsgUnreadStatus 订阅某个频道的消息未读状态和系统通知,单用户默认最多可订阅 1000 个频道。 频道的未读状态和频道相关系统通知。未读状态仅区分未读数为 0 和未读数大于 0 两种情况
NIMQChatSubscribeTypeServerMsg 订阅某个服务器的系统通知,单用户默认最多可订阅 2000 个服务器 服务器相关系统通知,如服务器基本信息修改、人员进出、权限变更、创建频道等
NIMQChatSubscribeTypeChannelTypingEvent 订阅某个频道的“消息正在输入”事件,单用户默认最多可订阅 100 个频道 “消息正在输入”事件信息
注意:该事件信息的接收,不受服务器人数阈值的影响,即无论服务器人数是否超过阈值,用户都需要先订阅该事件,才能接收到事件信息。在频道界面上显示“消息正在输入”的实现流程,请参见消息正在输入
此文档是否对你有帮助?
有帮助
我要吐槽
  • 免除订阅的情况
  • 订阅方法
  • 订阅圈组服务器
  • 订阅频道
  • 订阅类型