Browse SDKs · uni-app / uni-app x
Platform
SDKsuni-app / uni-app x

Get specified group member info

Batch query group member profiles within a target group by user ID.

Copy

Invoke getSpecifiedGroupMembersInfo() to batch retrieve member details (such as group-specific nickname, role, avatar, and mute expiration) for known user IDs within a group.

Parameters

ParameterTypeRequiredDescription
groupIDstringYesTarget group identifier.
userIDListstring[]YesArray of member user IDs to query.

Code example

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

const result = await getSpecifiedGroupMembersInfo({
  groupID: groupID,
  userIDList: userIDList,
})
const members = result != null ? result.members : []

Return value

The Promise resolves with an OpenIMGroupMemberListResult | null object containing matched OpenIMGroupMemberItem[] elements in members. Returned records are not guaranteed to match the order of userIDList; map and cache members using the composite key groupID:userID. For data field definitions, see Get group member list.

State changes after the call

This is a read-only query that retrieves a local snapshot without emitting events. For active views, observe subsequent member changes via onGroupMemberInfoChanged as detailed in Get group member list.