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 推送问题排查
服务协议

服务端会话服务

更新时间: 2021/07/22 20:14:10

服务端会话服务与本地最近会话不同,其提供了新的会话列表获取服务,需要从云端拉取,不支持同步到本地最近会话列表。

  • 服务器支持存储用户全量的会话历史列表以及保存最近一条消息;

  • 客户端获取会话列表,支持按照需要指定获取的会话数,不与本地会话合并;

  • 不支持未读数;

获取会话列表

获取服务端会话列表,不依赖本地;

/**
 *  读取服务器会话列表block
 *
 *  @param error  错误,如果成功则error为nil
 *  @param recentSessions 读取的消息列表
 *  @param hasMore 最小时间戳只有请求第一页时会返回这个参数,表示下一次增量同步时带在请求参数里
 */
typedef void(^NIMFetchRecentSessionsHistoryBlock)(NSError * __nullable error,
                                                 NSArray<NIMRecentSession *> * __nullable       recentSessions,
                                                 BOOL hasMore);

@protocol NIMConversationManager <NSObject>
/**
*  从服务端分页获取历史会话列表
*
*  @param option 分页查询选项,可为空,空时默认全量获取
*
*  @param completion 完成回调
*/
- (void)fetchServerSessions:(nullable NIMFetchServerSessionOption *)option
                 completion:(nullable NIMFetchRecentSessionsHistoryBlock)completion;
@end

属性列表

参数 类型 说明
option NIMFetchServerSessionOption 获取最近会话选项
completion NIMFetchRecentSessionsHistoryBlock 结果列表

NIMRecentSession参数:

参数 类型 说明
session NIMSession 当前会话
unreadCount NSInteger 未读消息数
localExt NSDictionary 本地扩展
updateTime NSTimeInterval 服务端会话的最新更新时间,本地会话无效
serverExt NSString 会话服务扩展字段(本地会话该字段无效)
lastMessageType NIMLastMsgType 最后一条消息的类型(本地会话该字段无效)
lastMessage NIMMessage 最后一条消息
lastRevokeNotification NIMRevokeMessageNotification 最后一条消息的类型(本地会话该字段无效)

示例

// 下一页
NIMFetchServerSessionOption * option = [[NIMFetchServerSessionOption alloc] init];
option.needLastMessage = needLastMsg;
option.minTimestamp = min;
option.maxTimestamp = currentMin - 1;
option.limit = limit;
[[NIMSDK sharedSDK].conversationManager fetchServerSessions:option completion:^(NSError * _Nullable error, NSArray<NIMRecentSession *> * _Nullable recentSessions, BOOL hasMore) {}];

获取指定会话

获取指定服务端会话详细信息;

@protocol NIMConversationManager <NSObject>
/**
 *  从服务端获取会话信息
 *
 *  @param session 目标会话
 *
 *  @param completion 完成回调
 */
- (void)fetchServerSessionBySession:(NIMSession *)session
                         completion:(nullable NIMFetchRecentSessionHistoryBlock)completion;
@end

属性列表

参数 类型 说明
session NIMSession 目标会话
completion NIMFetchRecentSessionHistoryBlock 会话信息

示例

[[NIMSDK sharedSDK].conversationManager fetchServerSessionBySession:recent.session completion:^(NSError * _Nullable error, NIMRecentSession * _Nullable recentSession) {}];

修改服务端会话扩展

更新服务端会话扩展;

@protocol NIMConversationManager <NSObject>
/**
*  更新服务端获取会话扩展信息
*
*  @param ext        扩展信息
*
*  @param session    目标最近会话
*
*  @param completion 完成回调
*/
- (void)updateServerSessionExt:(NSString *)ext
                       session:(NIMSession *)session
                    completion:(nullable NIMRemoteRecentSessionBlock)completion;
@end

属性列表

参数 类型 说明
ext NSString 新的扩展值
session NIMSession 目标会话
completion NIMRemoteRecentSessionBlock 完成回调

示例

 [[NIMSDK sharedSDK].conversationManager updateServerSessionExt:@"newServerExt" session:recentSession.session completion:^(NSError * _Nullable error) { }];

删除服务端会话

@protocol NIMConversationManager <NSObject>
/**
*  删除服务端
*
*  @param sessions 目标会话
*
*  @param completion 完成回调
*/
- (void)deleteServerSessions:(NSArray<NIMSession *> *)sessions
                  completion:(nullable NIMRemoteRecentSessionBlock)completion;
@end

属性列表

参数 类型 说明
sessions NSArray 目标会话列表
completion NIMRemoteRecentSessionBlock 完成回调

示例

[[NIMSDK sharedSDK].conversationManager deleteServerSessions:@[recentSession.session] completion:^(NSError * _Nullable error) {}];
此文档是否对你有帮助?
有帮助
我要吐槽
  • 获取会话列表
  • 获取指定会话
  • 修改服务端会话扩展
  • 删除服务端会话