本文介绍游客功能的使用限制、实现方法、以及相关参考。

功能介绍

自 v1.6.0 起，圈组支持用户在正式成为服务器成员之前，先以游客身份加入服务器体验相应线上社区的部分内容、活动以及氛围，之后再决策是否需要正式加入服务器。游客相当于临时性的只读普通成员，只能查看服务器和频道内的部分信息，无法发送消息，因此无法与服务器成员形成互动。

以下为对游客支持的功能：

前提条件

• 已联系商务经理或技术支持开通圈组的游客功能。
• 用户在以游客身份加入服务器前，需已登录圈组。

实现方法

实现加入和退出服务器

• 调用enterAsVisitor方法以游客身份加入服务器。

  • 单个用户最多只能以游客身份加入 10 个服务器。因此，调用该方法时，最多可传入 10 个服务器 ID。如果超限，将以加入失败列表的形式返回。
  • 单个服务器的游客数量上限为 2000。如果超限，将以加入失败列表的形式返回。
  
  

  示例代码如下：

  var param = QChatEnterServerAsVisitorParam([serviceId]);
  NimCore.instance.qChatServerService.enterAsVisitor(param).then((value){
    
  });
  
  

• 调用leaveAsVisitor方法退出，调用时最多可传入 10 个服务器 ID。

  游客退出服务器后，订阅的服务器和频道将自动取消订阅。

  示例代码如下:

  var param = QChatLeaveServerAsVisitorParam([serviceId]);
  NimCore.instance.qChatServerService.leaveAsVisitor(param).then((value){
  
  });
  
  

实现消息接收

单个游客加入服务器后，可调用QChatChannelService#subscribeAsVisitor方法订阅对其可见的频道，从而在频道成员发送消息后接收消息，否则将无法接收。

示例代码如下:

var param = QChatSubscribeChannelAsVisitorParam(operateType: QChatSubscribeOperateType.sub,
    channelIdInfos: [channel])
    NimCore.instance.qChatChannelService.subscribeAsVisitor(param).then((value){
      
    });

实现系统通知接收

单个游客加入服务器后，可调用QChatServerService#subscribeAsVisitor方法订阅服务器，从而能够接收该服务器的部分事件通知，否则将无法接收。也可调用QChatChannelService#subscribeAsVisitor方法订阅该服务器下对该游客可见的频道，从而能够接收该频道的部分事件通知，否则将无法接收。

示例代码如下:

var param = QChatSubscribeServerAsVisitorParam(QChatSubscribeOperateType.sub,
    [serviceId]);
    NimCore.instance.qChatServerService.subscribeAsVisitor(param).then((value){
      
    });

var param = QChatSubscribeChannelAsVisitorParam(operateType: QChatSubscribeOperateType.sub,
    channelIdInfos: [channel])
    NimCore.instance.qChatChannelService.subscribeAsVisitor(param).then((value){
      
    });

实现查询操作

用户在以游客身份加入服务器后，可调用如下方法查询服务器、频道和消息。

相关参考

API调用时序

游客接收消息：

sequenceDiagram



note over NIM SDK: 双方初始化并登录 IM
note over NIM SDK: 双方登录圈组
note over NIM SDK: 游客加入服务器
游客 ->> NIM SDK: 以游客身份加入服务器<br>(enterAsVisitor)
note left of 游客: 游客加入服务器后，可查看对其可见的频道
note over NIM SDK: 游客订阅频道
游客 ->> NIM SDK: 以游客身份订阅频道<br>(QChatChannelService#<br>subscribeAsVisitor)
note left of 游客:游客必须订阅频道才能接收频道的消息
note over NIM SDK: 游客接收消息
服务器成员 ->> NIM SDK: 在已存频道内发送消息<br>(sendMessage)
NIM SDK ->> 游客: QChatMessage
note left of 游客: 游客无法发消息，只能收消息，且不计未读数
note over NIM SDK: 游客退出服务器
游客 ->> NIM SDK: 以游客身份退出服务器<br>(leaveAsVisitor)
note left of 游客: 游客退出后，不再接收消息

游客接收系统通知：

sequenceDiagram



note over NIM SDK: 双方初始化并登录 IM
note over NIM SDK: 双方登录圈组
note over NIM SDK: 游客加入服务器
游客 ->> NIM SDK: 以游客身份加入服务器<br>(enterAsVisitor)
note left of 游客: 游客加入服务器后,可查看<br>对其可见的频道
note over NIM SDK: 游客订阅服务器和频道
游客 ->> NIM SDK: 以游客身份订阅服务器<br>(QChatServerService#<br>subscribeAsVisitor)
note left of 游客:游客必须订阅服务器<br>才能接收服务器的系统通知
游客 ->> NIM SDK: 以游客身份订阅频道<br>(QChatChannelService#<br>subscribeAsVisitor)
note left of 游客:游客必须订阅频道<br>才能接收频道的消息和系统通知
note over NIM SDK: 游客接收系统通知
note left of 服务器成员: 游客可接收部分系统通知，<br>以下以频道删除为例
服务器成员 ->> NIM SDK: 删除频道<br>(removeChannel)
NIM SDK ->>  游客: "频道删除"的系统通知
note over NIM SDK: 游客退出服务器
游客 ->> NIM SDK: 以游客身份退出服务器<br>(leaveAsVisitor)
note left of 游客: 游客退出后，不再接收系统通知

游客的查询操作：

sequenceDiagram



note over NIM SDK: 双方初始化并登录 IM
note over NIM SDK: 双方登录圈组
note over NIM SDK: 游客加入服务器
游客 ->> NIM SDK: 以游客身份加入服务器<br>(enterAsVisitor)
note left of 游客: 游客加入服务器后，可查看对其可见的频道
note over NIM SDK: 游客进行相应查询
游客 ->> NIM SDK: 查询操作<br>(具体可调用的方法见上文)
note over NIM SDK: 游客退出服务器
游客 ->> NIM SDK: 以游客身份退出服务器<br>(leaveAsVisitor)

可接收的系统通知

圈组系统通知的类型在QChatSystemNotificationType枚举中定义，其中游客可接收的系统通知类型如下：