NIMHistoryMessageSearchOption Class Reference

Inherits from NSObject
Declared in NIMMessageSearchOption.h

Overview

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

  startTime

检索消息起始时间

@property (nonatomic, assign) NSTimeInterval startTime

Discussion

检索消息起始时间

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

Declared In

NIMMessageSearchOption.h

  limit

检索条数

@property (nonatomic, assign) NSUInteger limit

Discussion

检索条数

最大限制100条

Declared In

NIMMessageSearchOption.h

  endTime

检索消息终止时间,此参数对聊天室会话无效。

@property (nonatomic, assign) NSTimeInterval endTime

Discussion

检索消息终止时间,此参数对聊天室会话无效。

当前最早的时间,没有则传入 0。

Declared In

NIMMessageSearchOption.h

  currentMessage

检索消息的当前参考消息,返回的消息结果集里不会包含这条消息,此参数对聊天室会话无效。优先级低于下面的serverId

@property (nullable, nonatomic, strong) NIMMessage *currentMessage

Discussion

检索消息的当前参考消息,返回的消息结果集里不会包含这条消息,此参数对聊天室会话无效。优先级低于下面的serverId

传入最早时间,没有则传入nil。

Declared In

NIMMessageSearchOption.h

  serverId

检索消息的当前参考消息,返回的消息结果集里不会包含这条serverId对应的消息,此参数对聊天室会话无效。优先级高于 上面currentMessage的serverId

@property (nullable, nonatomic, copy) NSString *serverId

Discussion

检索消息的当前参考消息,返回的消息结果集里不会包含这条serverId对应的消息,此参数对聊天室会话无效。优先级高于 上面currentMessage的serverId

传入最早时间,没有则传入nil。

Declared In

NIMMessageSearchOption.h

  order

检索顺序。

@property (nonatomic, assign) NIMMessageSearchOrder order

Discussion

检索顺序。

Declared In

NIMMessageSearchOption.h

  sync

是否需要同步到 db,此参数对聊天室会话无效。

@property (nonatomic, assign) BOOL sync

Discussion

是否需要同步到 db,此参数对聊天室会话无效。

SDK 删除消息分为两种模式:标记删除和彻底删除(参见 NIMDeleteMessagesOption)。 若消息集在本地被标记删除,则意味着消息仍存在本地,但被打上了特殊的记号,同步后写入 db 会失败。 只有不存在本地的消息才可以通过 sync 标记进行 db 存储

Declared In

NIMMessageSearchOption.h

  messageTypes

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

@property (nonatomic, copy) NSArray<NSNumber*> *messageTypes

Discussion

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

Declared In

NIMMessageSearchOption.h

  syncMessageTypes

是否需要同步特定类型到 db,此参数对聊天室会话无效。

@property (nonatomic, assign) BOOL syncMessageTypes

Discussion

是否需要同步特定类型到 db,此参数对聊天室会话无效。

SDK 删除消息分为两种模式:标记删除和彻底删除(参见 NIMDeleteMessagesOption)。 若消息集在本地被标记删除,则意味着消息仍存在本地,但被打上了特殊的记号,同步后写入 db 会失败。 只有不存在本地的消息才可以通过 syncMessageTypes 标记进行 db 存储

Declared In

NIMMessageSearchOption.h

  customFilter

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

@property (nullable, nonatomic, strong) NIMHistoryMessageFilterBlock customFilter

Discussion

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

Declared In

NIMMessageSearchOption.h

  createRecentSessionIfNotExists

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

@property (nonatomic, assign) BOOL createRecentSessionIfNotExists

Discussion

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

Declared In

NIMMessageSearchOption.h