V2TIMMessageSearchParam

Public 成员函数
void	setConversationID (String conversationID)
void	setKeywordList (List< String > keywordList)
void	setKeywordListMatchType (int type)
void	setSenderUserIDList (List< String > userIDList)
void	setMessageTypeList (List< Integer > messageTypeList)
void	setSearchTimePosition (long searchTimePosition)
void	setSearchTimePeriod (long searchTimePeriod)
void	setPageSize (int pageSize)
void	setPageIndex (int pageIndex)
void	setSearchCount (int searchCount)
void	setSearchCursor (String searchCursor)
int	getPageIndex ()
int	getPageSize ()
List< String >	getKeywordList ()
List< Integer >	getMessageTypeList ()
long	getSearchTimePosition ()
long	getSearchTimePeriod ()

静态 Public 属性
static final int	V2TIM_KEYWORD_LIST_MATCH_TYPE_OR = 0
static final int	V2TIM_KEYWORD_LIST_MATCH_TYPE_AND = 1

Protected 成员函数
MessageSearchParam	getMessageSearchParam ()
String	getConversationID ()

成员函数说明

getMessageSearchParam()

MessageSearchParam getMessageSearchParam ( )

inlineprotected

getConversationID()

String getConversationID ( )

inlineprotected

setConversationID()

void setConversationID ( String  conversationID )

inline

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

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

如果设置 conversationID != null，代表搜索指定会话。会话唯一 ID，C2C 单聊组成方式为: String.format("c2c_%s", "userID")；群聊组成方式为: String.format("group_%s", "groupID")

setKeywordList()

void setKeywordList ( List< String >  keywordList )

inline

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

setKeywordListMatchType()

void setKeywordListMatchType ( int  type )

inline

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

setSenderUserIDList()

void setSenderUserIDList ( List< String >  userIDList )

inline

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

setMessageTypeList()

void setMessageTypeList ( List< Integer >  messageTypeList )

inline

指定搜索的消息类型集合，传 null 表示搜索支持的全部类型消息（V2TIMFaceElem 和 V2TIMGroupTipsElem 不支持）。

setSearchTimePosition()

void setSearchTimePosition ( long  searchTimePosition )

inline

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

setSearchTimePeriod()

void setSearchTimePeriod ( long  searchTimePeriod )

inline

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

setPageSize()

void setPageSize ( int  pageSize )

inline

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

注意

仅对接口 searchLocalMessages 生效

setPageIndex()

void setPageIndex ( int  pageIndex )

inline

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

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

注意

仅对接口 searchLocalMessages 生效

setSearchCount()

void setSearchCount ( int  searchCount )

inline

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

注意

仅对接口 searchCloudMessages 生效

setSearchCursor()

void setSearchCursor ( String  searchCursor )

inline

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

注意

仅对接口 searchCloudMessages 生效

getPageIndex()

int getPageIndex ( )

inline

getPageSize()

int getPageSize ( )

inline

getKeywordList()

List<String> getKeywordList ( )

inline

getMessageTypeList()

List<Integer> getMessageTypeList ( )

inline

getSearchTimePosition()

long getSearchTimePosition ( )

inline

getSearchTimePeriod()

long getSearchTimePeriod ( )

inline

结构体成员变量说明

V2TIM_KEYWORD_LIST_MATCH_TYPE_OR

final int V2TIM_KEYWORD_LIST_MATCH_TYPE_OR = 0

static

V2TIM_KEYWORD_LIST_MATCH_TYPE_AND

final int V2TIM_KEYWORD_LIST_MATCH_TYPE_AND = 1

static