please select
  • UIKit
  • SDK
  • Server APIs
Chat/
SDK/
Flutter/
Local Search/
SDK
  • Install Chat SDK
    • Install
  • Initialize Chat SDK
    • Initialize
  • Login And Logout
    • Login and Logout
  • Message
    • Message Overview
    • Sending Message
    • Receiving Message
    • Historical Message
    • Forwarding Message
    • Modifying Message
    • Message Inserting
    • Deleting Message
    • Clearing Messages
    • Recalling Message
    • Online Message
    • Read Receipt
    • Querying Message
    • Group @ Message
    • Targeted Group Message
    • Notification Muting
    • Message Extension
  • Conversation
    • Conversation Overview
    • Conversation List
    • Getting Conversation
    • Conversation Unread Count
    • Pinning Conversation to the Top
    • Deleting Conversation
    • Conversation Draft
    • Conversation Group
  • Group
    • Group Overview
    • Group Management
    • Group Profile
    • Group Member Management
    • Group Member Profile
    • Custom Group Attribute
  • User
    • User Profile
    • Friend Management
    • Friend List
    • Blocklist
  • Offline Push
    • Offline Push
  • Signaling
    • Signaling Management
  • Local Search
    • Searching for Message
    • Searching for Friend
    • Searching Group
    • Searching for Group Member
  • API Reference
    • Client APIs
  • Guideline for Beginners
  • Console Guide
    • Creating and Upgrading an Application
    • Basic Configuration
    • Feature Configuration
    • Account Management
    • Group Management
    • Webhook Configuration
  • Product Introduction
    • Message Management
      • One-to-One Message
      • Message Storage
      • Offline Push
      • Group Message
      • Message Formats
    • Account System
      • Login Authentication
      • Online Status Management
    • Group Related
      • Group System
      • Group Management
    • User Profile and Relationship Chain
      • Profile Management
      • Relationship Chain Management
  • Purchase Guide
    • Billing Overview
    • Pricing
  • Error Codes

Searching for Group Member

Overview

Only locally stored group members can be searched for, such as the list of group members or group member profiles that have been pulled.
Note:
This feature is supported by the SDK for Flutter on v3.8.0 or later. It cannot be used for audio-video groups (AVChatRoom) as the group members are not stored locally.

Searching a Local Group

Call the searchGroupMembers API to search for a local group member. You can set the search keyword keywordList and specify the search scope to set whether to search by the memberUserID, memberNickName, memberRemark, and memberNameCard fields of group members.
Depending on whether groupIDList of V2TIMGroupMemberSearchParam in searchGroupMembers is empty (null/nil), there are two cases:
If groupIDList is left empty, members in all the groups will be searched for and returned by groupID.
If groupIDList is not left empty, members in the specified group will be searched for.
Sample code:
// Set the search parameter
V2TimGroupMemberSearchParam param = V2TimGroupMemberSearchParam(
groupIDList: [],// Set the group ID list. If null is passed in, group members of all groups are searched.
isSearchMemberNameCard: true,// Specify whether to search for a group member's name card. Default value: `true`.
isSearchMemberRemark: true,// Specify whether to search for a group member's remarks. Default value: `true`.
isSearchMemberNickName: true,// Specify whether to search for a group member's nickname. Default value: `true`.
isSearchMemberUserID: true,// Specify whether to search for a group member's `userID`. Default value: `true`.
keywordList: []);// Search for the list of keywords. Up to five keywords are supported.
// Search for a group member
V2TimValueCallback<V2GroupMemberInfoSearchResult> searchGroupMembersRes =
await TencentImSDKPlugin.v2TIMManager
.getGroupManager()
.searchGroupMembers(param: param); // Parameter for searching for a group member
if (searchGroupMembersRes.code == 0) {
// Data found successfully
searchGroupMembersRes.data?.groupMemberSearchResultItems;// Group member search result
}