Public Member Functions | |
V2TIMMessageSearchParam () | |
V2TIMMessageSearchParam (const V2TIMMessageSearchParam &) | |
V2TIMMessageSearchParam & | operator= (const V2TIMMessageSearchParam &) |
~V2TIMMessageSearchParam () | |
Data Fields | |
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 | ( | const V2TIMMessageSearchParam & | ) |
V2TIMMessageSearchParam& operator= | ( | const V2TIMMessageSearchParam & | ) |
V2TIMStringVector keywordList |
The keyword list can contain up to 5 keywords. When the sender and type of the message are not specified, the keyword list must be non-empty. Otherwise, the keyword list can be empty.
V2TIMKeywordListMatchType keywordListMatchType |
Set the keyword list matching type, which can be the OR or AND relationship search. The options are V2TIM_KEYWORD_LIST_MATCH_TYPE_OR (default) and V2TIM_KEYWORD_LIST_MATCH_TYPE_AND.
V2TIMStringVector senderUserIDList |
Set userIDs for message sending. Up to 5 userIDs are supported.
V2TIMElemTypeVector messageTypeList |
Set the message types to search. If an empty array is passed in, all message types supported are searched (V2TIMFaceElem and V2TIMGroupTipsElem are not supported).
V2TIMString conversationID |
Search all conversations or a specified conversation
conversationID == null: search all conversations
conversationID != null: search a specified conversation. Unique ID of a conversation. For one-to-one chats, the value format is "c2c_userID". For group chats, the value format is "group_groupID".
uint32_t searchTimePosition |
Start time for search. The default value is 0, indicating to start search now. The value can also be the UTC timestamp, in seconds.
uint32_t searchTimePeriod |
A time period in the past starting from the start time, in seconds. The default value 0 indicates that the time range is not limited. The value 24x60x60 indicates the past day.
uint32_t pageIndex |
Page number: used for the paginated display of the search results. Page numbers must start from 0. For example, to display 10 results per page, call the API according to the following rules:
uint32_t pageSize |
Count of results per page: used for the paginated display of the search results. If you do not want to paginate the search results, set the parameter to 0. However, a large count of search results without pagination may cause performance issues.
uint32_t searchCount |
Count of cloud search results
V2TIMString searchCursor |
The starting position for cloud search. Set an empty string for the first time, and pass in the value of searchCursor in V2TIMMessageSearchResult when continuing to search.