#import <NIMMessageSearchOption.h>

类 NIMHistoryMessageSearchOption 继承关系图:

属性
NSTimeInterval	startTime

NSUInteger	limit

NSTimeInterval	endTime

NIMMessage *	currentMessage

NSString *	serverId

NIMMessageSearchOrder	order

BOOL	sync

NSArray< NSNumber * > *	messageTypes

BOOL	syncMessageTypes

NIMHistoryMessageFilterBlock	customFilter

BOOL	createRecentSessionIfNotExists

详细描述

检索服务器历史消息选项 (服务器)

属性说明

◆ createRecentSessionIfNotExists

- (BOOL) createRecentSessionIfNotExists

readwritenonatomicassign

同步云端消息到到本地时，如果消息所在的最近会话不存在，是否自动创建。默认为NO。

◆ currentMessage

- (NIMMessage*) currentMessage

readwritenonatomicstrong

检索消息的当前参考消息,返回的消息结果集里不会包含这条消息,此参数对聊天室会话无效。优先级低于下面的serverId @discussion 传入最早时间,没有则传入nil。

◆ customFilter

- (NIMHistoryMessageFilterBlock) customFilter

readwritenonatomicstrong

自定义消息过滤 @discusssion 自定义外部过滤回调方法。返回YES表示消息被过滤，不入库不回调，返回NO，表示消息正常入库和回调回调在内部工作线程，注意不要再该回调中执行阻塞或者耗时操作，防止影响内部的消息处理流程。

◆ endTime

- (NSTimeInterval) endTime

readwritenonatomicassign

检索消息终止时间,此参数对聊天室会话无效。 @discussion 当前最早的时间,没有则传入 0。

◆ limit

- (NSUInteger) limit

readwritenonatomicassign

检索条数 @discussion 最大限制100条

◆ messageTypes

- (NSArray<NSNumber *>*) messageTypes

readwritenonatomiccopy

查询的消息类型 @discusssion 消息类型组合，默认为 nil ，搜索全类型。一旦设置了这个字段，则 sync 字段失效，查询结果不会写入 db，需要通过设置syncMessageTypes来同步。

◆ order

- (NIMMessageSearchOrder) order

readwritenonatomicassign

检索顺序。

◆ serverId

- (NSString*) serverId

readwritenonatomiccopy

检索消息的当前参考消息,返回的消息结果集里不会包含这条serverId对应的消息,此参数对聊天室会话无效。优先级高于上面currentMessage的serverId @discussion 传入最早时间,没有则传入nil。

◆ startTime

- (NSTimeInterval) startTime

readwritenonatomicassign

检索消息起始时间 @discussion 需要检索的起始时间,没有则传入0。

◆ sync

- (BOOL) sync

readwritenonatomicassign

是否需要同步到 db，此参数对聊天室会话无效。 @discussion SDK 删除消息分为两种模式：标记删除和彻底删除（参见 NIMDeleteMessagesOption）。若消息集在本地被标记删除，则意味着消息仍存在本地，但被打上了特殊的记号，同步后写入 db 会失败。只有不存在本地的消息才可以通过 sync 标记进行 db 存储

◆ syncMessageTypes

- (BOOL) syncMessageTypes

readwritenonatomicassign

是否需要同步特定类型到 db，此参数对聊天室会话无效。 @discussion SDK 删除消息分为两种模式：标记删除和彻底删除（参见 NIMDeleteMessagesOption）。若消息集在本地被标记删除，则意味着消息仍存在本地，但被打上了特殊的记号，同步后写入 db 会失败。只有不存在本地的消息才可以通过 syncMessageTypes 标记进行 db 存储

该类的文档由以下文件生成:

NIMMessageSearchOption.h