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.
Public Member Functions | Data Fields
V2TIMGroupMemberSearchParam

Detailed Description

Definition of V2TIMGroupMemberSearchParam.

Public Member Functions

 V2TIMGroupMemberSearchParam ()
 
 V2TIMGroupMemberSearchParam (const V2TIMGroupMemberSearchParam &groupMemberSearchParam)
 
 ~V2TIMGroupMemberSearchParam ()
 

Data Fields

V2TIMStringVector keywordList
 
V2TIMStringVector groupIDList
 
bool isSearchMemberUserID
 
bool isSearchMemberNickName
 
bool isSearchMemberRemark
 
bool isSearchMemberNameCard
 
V2TIMKeywordListMatchType keywordListMatchType
 
uint32_t searchCount
 
V2TIMString searchCursor
 

Constructor & Destructor Documentation

◆ V2TIMGroupMemberSearchParam() [1/2]

V2TIMGroupMemberSearchParam ( )

◆ V2TIMGroupMemberSearchParam() [2/2]

V2TIMGroupMemberSearchParam ( const V2TIMGroupMemberSearchParam &  groupMemberSearchParam)

◆ ~V2TIMGroupMemberSearchParam()

~V2TIMGroupMemberSearchParam ( )

Field Documentation

◆ keywordList

V2TIMStringVector keywordList

Keyword list to search. 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.

◆ groupIDList

V2TIMStringVector groupIDList

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

◆ isSearchMemberUserID

bool isSearchMemberUserID

Search by userID (only valid for local search)

◆ isSearchMemberNickName

bool isSearchMemberNickName

Search by nickname (only valid for local search)

◆ isSearchMemberRemark

bool isSearchMemberRemark

Search by remarks (only valid for local search)

◆ isSearchMemberNameCard

bool isSearchMemberNameCard

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

◆ keywordListMatchType

V2TIMKeywordListMatchType keywordListMatchType

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)

◆ searchCount

uint32_t searchCount

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

◆ searchCursor

V2TIMString searchCursor

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