iOS

游客功能

更新时间: 2024/03/14 17:08:38

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

功能介绍

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

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

功能
说明
限制
加入和退出服务器 以游客身份加入和退出服务器,加入服务器后,可查看对其可见的频道和频道分组。频道是否对游客可见,可在频道创建和修改时设置。频道分组是否对游客可见,由其所包含的频道决定,具体见频道管理频道分组
  • 应用需已开通游客功能
  • 服务器成员被封禁后不能再以游客身份加入
接收消息 接收成员在频道内发送的消息,接收到的消息无已读未读逻辑,不支持展示未读数 必须先订阅频道
接收服务器的系统通知 接收服务器相关事件的通知,具体可接收的通知类型,参见下文的可接收的系统通知 必须先订阅服务器
接收频道的系统通知 接收频道相关事件的通知,具体可接收的通知类型,参见下文的可接收的系统通知 必须先订阅频道
查询部分信息 查询服务器、频道、消息和频道分组的部分信息,具体可调用的 SDK API,见下文的实现查询操作 只能调用相应的 SDK API,无法调用服务端 API
断网重连 用户以游客身份加入服务器后,如果网络异常断开,用户将在网络恢复时自动重新以游客身份加入服务器,如果游客之前已订阅服务器和服务器下的频道,将自动重新订阅 -

前提条件

  • 开通圈组的游客功能。游客功能需要在开通圈组功能的基础上额外开通后才能使用。
  • 用户在以游客身份加入服务器前,需已登录圈组。

实现方法

实现加入和退出服务器

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

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

    示例代码如下:

    objcNIMQChatEnterServerAsVisitorParam *param = [[NIMQChatEnterServerAsVisitorParam alloc] init];
    param.serverIds = serverIds;
    [NIMSDK.sharedSDK.qchatServerManager enterAsVisitor:param completion:^(NSError *__nullable error, NIMQChatEnterServerAsVisitorResult *__nullable result)
    {
        // your code
    }];
    
  • 调用leaveAsVisitor:completion:方法退出,调用时最多可传入 10 个服务器 ID。

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

    示例代码如下:

    objcNIMQChatLeaveServerAsVisitorParam *param = [[NIMQChatLeaveServerAsVisitorParam alloc] init];
    param.serverIds = serverIds;
    [NIMSDK.sharedSDK.qchatServerManager leaveAsVisitor:param completion:^(NSError *__nullable error, NIMQChatLeaveServerAsVisitorResult *__nullable result)
    {
        // your code
    }];
    

实现消息接收

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

  • 一位游客最多可订阅 100 个频道。
  • 不支持对游客显示消息未读数。
  • 游客无法接收消息的离线推送。

示例代码如下:

objcNIMQChatSubscribeChannelAsVisitorParam *param = [[NIMQChatSubscribeChannelAsVisitorParam alloc] initWithOperateType:operationType channelIdInfos:serverIds];
[NIMSDK.sharedSDK.qchatChannelManager subscribeAsVisitor:param completion:^(NSError *__nullable error, NIMQChatSubscribeChannelAsVisitorResult *__nullable result)
{
    // your code
}];

实现系统通知接收

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

一位游客最多可订阅 10 个服务器和 100 个频道。


示例代码如下:

订阅服务器
objcNIMQChatSubscribeServerAsVisitorParam *param = [[NIMQChatSubscribeServerAsVisitorParam alloc] initWithOperateType:operationType serverIds:serverIds];
param.serverIds = serverIds;
[NIMSDK.sharedSDK.qchatServerManager subscribeAsVisitor:param completion:^(NSError *__nullable error, NIMQChatSubscribeServerAsVisitorResult *__nullable result)
{
    // your code
}];
订阅频道
objcNIMQChatSubscribeChannelAsVisitorParam *param = [[NIMQChatSubscribeChannelAsVisitorParam alloc] initWithOperateType:operationType channelIdInfos:serverIds];
[NIMSDK.sharedSDK.qchatChannelManager subscribeAsVisitor:param completion:^(NSError *__nullable error, NIMQChatSubscribeChannelAsVisitorResult *__nullable result)
{
    // your code
}];

实现查询操作

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

模块
方法
说明 相关文档
服务器 getServers:completion: 根据服务器的 ID 查询对应的服务器的信息 根据服务器ID查询服务器
频道 getChannels:completion: 根据频道 ID 查询频道信息 根据频道ID查询频道
getChannelsByPage:completion: 根据时间分页查询频道列表(仅返回对游客可见的频道 分页查询频道列表
getChannelMembersByPage:completion: 根据时间分页查询频道成员列表 分页查询频道成员列表
getLastMessageOfChannels:completion: 获取多个频道的最后一条消息 获取频道最后一条消息
消息 getMessageHistory:completion: 查询历史消息 查询历史消息
getMessageHistoryByIds:completion: 根据回复消息的服务端 ID 查询历史回复消息(:需先在云信控制台开通圈组的会话消息回复功能) 根据消息 ID 批量查询回复消息
getThreadMessages:completion: 根据某个 Thread 中的任意一条消息分页查询该 Thread 的消息列表,即该 Thread 的聊天历史(:需先在云信控制台开通圈组的会话消息回复功能) 查询Thread消息列表
batchGetMessageThreadInfo:completion: 批量查询某个频道下的多个 Thread 的根消息的 meta 信息,包括总回复数和最后回复时间 (:需先在云信控制台开通圈组的会话消息回复功能) 批量查询根消息meta信息
fetchQuickComments:completion: 查询指定消息所包含的快捷评论列表 (:需先在云信控制台开通圈组的快捷评论功能) 查询快捷评论列表
频道分组 getChannelCategories 根据频道分组的 ID 查询频道分组信息 频道分组

相关参考

API调用时序

游客接收消息
uml diagram
游客接收系统通知
uml diagram
游客的查询操作
uml diagram

可接收的系统通知

圈组系统通知的类型在NIMQChatSystemNotificationType枚举中定义,其中游客可接收的系统通知类型如下:

枚举值 说明
接收条件
NIMQChatSystemNotificationTypeVisitorChannelVisibilityUpdate 频道对游客可见性变更频道对游客的可见性,可通过修改频道的visitorMode属性进行变更,也可能因频道分组的属性变更而变更。具体参见频道管理中对游客可见性的说明。 订阅频道且在线
NIMQChatSystemNotificationTypeUpdateQuickComment 更新快捷评论 订阅频道且在线
NIMQChatSystemNotificationTypeCustom 自定义系统通知 订阅服务器或频道且在线
NIMQChatSystemNotificationTypeServerRemove 删除服务器 订阅服务器且在线
NIMQChatSystemNotificationTypeServerUpdate 修改服务器信息 订阅服务器且在线
NIMQChatSystemNotificationTypeChannelCreate 创建频道 订阅服务器且在线
NIMQChatSystemNotificationTypeChannelRemove 删除频道 订阅频道且在线
NIMQChatSystemNotificationTypeChannelUpdate 修改频道 订阅频道且在线
NIMQChatSystemNotificationTypeCreateChannelCategory 创建频道分组 订阅服务器且在线
NIMQChatSystemNotificationTypeDeleteChannelCategory 删除频道分组 订阅服务器且在线
NIMQChatSystemNotificationTypeUpdateChannelCategory 修改频道分组信息 订阅服务器且在线
此文档是否对你有帮助?
有帮助
去反馈
  • 功能介绍
  • 前提条件
  • 实现方法
  • 实现加入和退出服务器
  • 实现消息接收
  • 实现系统通知接收
  • 实现查询操作
  • 相关参考
  • API调用时序
  • 可接收的系统通知