IM 即时通讯
圈组订阅机制
更新时间: 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 个频道 | “消息正在输入”事件信息 注意:该事件信息的接收,不受服务器人数阈值的影响,即无论服务器人数是否超过阈值,用户都需要先订阅该事件,才能接收到事件信息。在频道界面上显示“消息正在输入”的实现流程,请参见消息正在输入 |
此文档是否对你有帮助?
有帮助
我要吐槽