IMSDK
即时通信 IM 提供全球接入、单聊、群聊、消息推送、资料关系链托管、账号鉴权等全方位解决方案,并提供完备的 App 接入、后台管理接口。
V2TIMMessageSearchParam

详细描述

消息搜索参数

Public 成员函数

 V2TIMMessageSearchParam ()
 
 V2TIMMessageSearchParam (const V2TIMMessageSearchParam &)
 
V2TIMMessageSearchParamoperator= (const V2TIMMessageSearchParam &)
 
 ~V2TIMMessageSearchParam ()
 

成员变量

V2TIMStringVector keywordList
 
V2TIMKeywordListMatchType keywordListMatchType
 
V2TIMStringVector senderUserIDList
 
V2TIMElemTypeVector messageTypeList
 
V2TIMString conversationID
 
uint32_t searchTimePosition
 
uint32_t searchTimePeriod
 
uint32_t pageIndex
 
uint32_t pageSize
 
uint32_t searchCount
 
V2TIMString searchCursor
 

构造及析构函数说明

◆ V2TIMMessageSearchParam() [1/2]

◆ V2TIMMessageSearchParam() [2/2]

◆ ~V2TIMMessageSearchParam()

成员函数说明

◆ operator=()

结构体成员变量说明

◆ keywordList

V2TIMStringVector keywordList

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

◆ keywordListMatchType

V2TIMKeywordListMatchType keywordListMatchType

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

◆ senderUserIDList

V2TIMStringVector senderUserIDList

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

◆ messageTypeList

V2TIMElemTypeVector messageTypeList

指定搜索的消息类型集合,传入空数组表示搜索支持的全部类型消息(V2TIMFaceElem 和 V2TIMGroupTipsElem 不支持)取值详见 @V2TIMElemType。

◆ conversationID

V2TIMString conversationID

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

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

如果设置 conversationID != nil,代表搜索指定会话。会话唯一 ID,C2C 单聊组成方式为: "c2c_userID":群聊组成方式为: "group_groupID"

◆ searchTimePosition

uint32_t searchTimePosition

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

◆ searchTimePeriod

uint32_t searchTimePeriod

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

◆ pageIndex

uint32_t pageIndex

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

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

◆ pageSize

uint32_t pageSize

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

注意
仅对接口 searchLocalMessages 生效

◆ searchCount

uint32_t searchCount

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

注意
仅对接口 searchCloudMessages 生效

◆ searchCursor

V2TIMString searchCursor

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

注意
仅对接口 searchCloudMessages 生效