IMSDK
IM features a comprehensive suite of solutions including global access, one-to-one chat, group chat, message push, profile and relationship chain hosting, and account authentication. It also provides complete app access and backend management APIs.
V2TIMGroupMemberSearchParam

Public Member Functions

void setKeywordList (List< String > keywordList)
 
void setGroupIDList (List< String > groupIDList)
 
void setSearchMemberUserID (boolean isSearchMemberUserID)
 
void setSearchMemberNickName (boolean isSearchMemberNickName)
 
void setSearchMemberRemark (boolean isSearchMemberRemark)
 
void setSearchMemberNameCard (boolean isSearchMemberNameCard)
 
void setKeywordListMatchType (int type)
 
void setSearchCount (int searchCount)
 
void setSearchCursor (String searchCursor)
 

Member Function Documentation

◆ setKeywordList()

void setKeywordList ( List< String >  keywordList)
inline

Set the search keyword list. Up to 5 keywords are supported. You need to specifiy which fields(group member id 、nickname、remark or name card) to be matched with the keyword list in local search. All fields(group member id 、nickname and name card) will be matched with the keyword list in cloud search.

◆ setGroupIDList()

void setGroupIDList ( List< String >  groupIDList)
inline

Set group ID list to search. If null is passed in, group members of all joined groups will be searched.

◆ setSearchMemberUserID()

void setSearchMemberUserID ( boolean  isSearchMemberUserID)
inline

Search by userID (only valid for local search)

◆ setSearchMemberNickName()

void setSearchMemberNickName ( boolean  isSearchMemberNickName)
inline

Search by nickname (only valid for local search)

◆ setSearchMemberRemark()

void setSearchMemberRemark ( boolean  isSearchMemberRemark)
inline

Search by remarks (only valid for local search)

◆ setSearchMemberNameCard()

void setSearchMemberNameCard ( boolean  isSearchMemberNameCard)
inline

Search by group member alias (only valid for local search)

◆ setKeywordListMatchType()

void setKeywordListMatchType ( int  type)
inline

Whether to combine the keywords with OR (V2TIM_KEYWORD_LIST_MATCH_TYPE_OR) or AND (V2TIM_KEYWORD_LIST_MATCH_TYPE_AND). The default is OR (only valid for cloud search)

◆ setSearchCount()

void setSearchCount ( int  searchCount)
inline

The count of group members returned per cloud search (must be greater than 0, maximum supported is 100, default is 20, only valid for cloud search)

◆ setSearchCursor()

void setSearchCursor ( String  searchCursor)
inline

Set the starting position for a cloud search. For the first call, leave the parameter empty. For subsequent calls, pass in the value of nextCursor in V2TIMGroupMemberSearchResult (only valid for cloud search)