SDKsuni-app / uni-app x

Search group members

Search members within a specified group by user ID or group nickname.

Invoke searchGroupMembers() to search members within a group by user ID or group-specific nickname, ideal for member filtering and @mention candidate pickers. The SDK utilizes the first non-empty keyword in keywordList.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`keywordList`	`string[]`	Yes	Array of search strings. Supply a trimmed, non-empty keyword.
`isSearchUserID`	`boolean`	Yes	Whether to match against member user IDs.
`isSearchMemberNickname`	`boolean`	Yes	Whether to match against member group nicknames.

Code example

import { searchGroupMembers } from '@/uni_modules/unix-openim-sdk'

const result = await searchGroupMembers({
  groupID: groupID,
  keywordList: [keyword.trim()],
  isSearchUserID: true,
  isSearchMemberNickname: true,
})
const members = result != null ? result.members : []

Return value

The Promise resolves with an OpenIMGroupMemberListResult | null object containing an array of matched OpenIMGroupMemberItem elements in members. Track matched records using the composite key groupID:userID. For data property definitions, see Get group member list.

State changes after the call

Search results represent a transient subset and should not overwrite your complete cached group member roster. When the keyword or filter dimensions change, execute a new search query and replace the search result set.

Was this page helpful?