V2TIMMessageSearchParam

详细描述

消息搜索参数

属性
NSArray< NSString * > *	keywordList
V2TIMKeywordListMatchType	keywordListMatchType
NSArray< NSString * > *	senderUserIDList
NSArray< NSNumber * > *	messageTypeList
NSString *	conversationID
NSUInteger	searchTimePosition
NSUInteger	searchTimePeriod
NSUInteger	pageIndex
NSUInteger	pageSize
NSUInteger	searchCount
NSString *	searchCursor

属性说明

keywordList

- (NSArray<NSString *>*) keywordList

readwritenonatomicstrong

关键字列表，最多支持5个。当消息发送者以及消息类型均未指定时，关键字列表必须非空；否则，关键字列表可以为空。

keywordListMatchType

- (V2TIMKeywordListMatchType) keywordListMatchType

readwritenonatomicassign

指定关键字列表匹配类型，可设置为“或”关系搜索或者“与”关系搜索. 取值分别为 V2TIM_KEYWORD_LIST_MATCH_TYPE_OR 和 V2TIM_KEYWORD_LIST_MATCH_TYPE_AND，默认为“或”关系搜索。

senderUserIDList

- (NSArray<NSString *>*) senderUserIDList

readwritenonatomicstrong

指定 userID 发送的消息，最多支持5个。

messageTypeList

- (NSArray<NSNumber *>*) messageTypeList

readwritenonatomicstrong

指定搜索的消息类型集合，传 nil 表示搜索支持的全部类型消息（V2TIMFaceElem 和 V2TIMGroupTipsElem 不支持）取值详见 @V2TIMElemType。

conversationID

- (NSString*) conversationID

readwritenonatomicstrong

搜索“全部会话”还是搜索“指定的会话”：

如果设置 conversationID == nil，代表搜索全部会话。

如果设置 conversationID != nil，代表搜索指定会话。会话唯一 ID, C2C 单聊组成方式：[NSString stringWithFormat:"c2c_%",userID]；群聊组成方式为 [NSString stringWithFormat:"group_%",groupID]

searchTimePosition

- (NSUInteger) searchTimePosition

readwritenonatomicassign

搜索的起始时间点。默认为0即代表从现在开始搜索。UTC 时间戳，单位：秒

searchTimePeriod

- (NSUInteger) searchTimePeriod

readwritenonatomicassign

从起始时间点开始的过去时间范围，单位秒。默认为0即代表不限制时间范围，传24x60x60代表过去一天。

pageIndex

- (NSUInteger) pageIndex

readwritenonatomicassign

分页的页号：用于分页展示查找结果，从零开始起步。 比如：您希望每页展示 10 条结果，请按照如下规则调用：

• 首次调用：通过参数 pageSize = 10, pageIndex = 0 调用 searchLocalMessage，从结果回调中的 totalCount 可以获知总共有多少条结果。
• 计算页数：可以获知总页数：totalPage = (totalCount % pageSize == 0) ? (totalCount / pageSize) : (totalCount / pageSize + 1) 。
• 再次调用：可以通过指定参数 pageIndex （pageIndex < totalPage）返回后续页号的结果。

注意

仅对接口 searchLocalMessages 生效

pageSize

- (NSUInteger) pageSize

readwritenonatomicassign

每页结果数量：用于分页展示查找结果，如不希望分页可将其设置成 0，但如果结果太多，可能会带来性能问题。

注意

仅对接口 searchLocalMessages 生效

searchCount

- (NSUInteger) searchCount

readwritenonatomicassign

每次云端搜索返回结果的条数。

注意

仅对接口 searchCloudMessages 生效

searchCursor

- (NSString*) searchCursor

readwritenonatomicstrong

每次云端搜索的起始位置。第一次填空字符串，续拉时填写 V2TIMMessageSearchResult 中的返回值。

注意

仅对接口 searchCloudMessages 生效