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

游客功能

更新时间: 2023/02/07 14:36:18

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

功能介绍

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

游客功能需要在开通圈组功能的基础上额外开通后才能使用。


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

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

前提条件

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

实现方法

实现加入和退出服务器

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

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

    示例代码如下:

    NIMQChatEnterServerAsVisitorParam *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。

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

    示例代码如下:

    NIMQChatLeaveServerAsVisitorParam *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 个频道。
  • 不支持对游客显示消息未读数。
  • 游客无法接收消息的离线推送。

示例代码如下:

NIMQChatSubscribeChannelAsVisitorParam *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 个频道。


示例代码如下:

订阅服务器
NIMQChatSubscribeServerAsVisitorParam *param = [[NIMQChatSubscribeServerAsVisitorParam alloc] initWithOperateType:operationType serverIds:serverIds];
param.serverIds = serverIds;
[NIMSDK.sharedSDK.qchatServerManager subscribeAsVisitor:param completion:^(NSError *__nullable error, NIMQChatSubscribeServerAsVisitorResult *__nullable result)
{
    // your code
}];
订阅频道
NIMQChatSubscribeChannelAsVisitorParam *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查询服务器
getServerMembers:completion: 根据服务器成员的 ID 查询服务器成员的信息 根据账号查询服务器成员
getServerMembersByPage:completion: 根据时间分页查询服务器成员列表 分页查询服务器成员列表
频道 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调用时序
  • 可接收的系统通知