please select
  • UIKit
  • SDK
  • Server APIs
Chat/
SDK/
React Native/
Local Search/
SDK
  • Run Demo
  • SDK Integration
  • Initialization
  • 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
  • Group
    • Overview
    • Group Management
    • Group Profile
    • Group Member Management
    • Group Member Profile
    • Custom Group Attribute
    • Community Management
  • User
    • User Profile
    • Friend Management
    • Friend List
    • Blocklist
  • Offline Push
    • Offline Push
  • Local Search
    • Searching for Message
    • Searching for Friend
    • Searching Group
    • Searching for Group Member
  • Signaling
    • Signaling Management
  • Changelog
  • 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
Docs Overview/
Chat/
SDK/
React Native/
Local Search/
Searching for Group Member/

Searching for Group Member

Feature Description

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 cannot be used for audio-video groups (AVChatRoom) as the group members are not stored locally.

Searching a Local Group

Call the searchGroupMembers API (Details) 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 a group member.
Depending on whether groupIDList of the V2TIMGroupMemberSearchParam (Details) 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:
// Search for group members by the keyword and group ID
const searchGroupMem = await groupManager.searchGroupMembers({
  groupIDList: ["The group ID can be specified"],
  keywordList: ["Keyword"],
  isSearchMemberNameCard: true,
  isSearchMemberNickName: true,
  isSearchMemberRemark: true,
  isSearchMemberUserID: true,
});