SDKsuni-app / uni-app x

Set group member extension data

Store custom application-level extension strings on a designated group member.

Invoke setGroupMemberInfo() to set a custom extension string on a group member record. The ex property stores an opaque string; the SDK does not perform automatic JSON merging. When multiple modules share this attribute, structure namespaces carefully and retain other fields before writing.

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`userID`	`string`	Yes	Target member user ID.
`ex`	`string`	Yes	Custom extension string; completely overwrites existing member extension data.

Code example

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

await setGroupMemberInfo({
  groupID: groupID,
  userID: targetUserID,
  ex: JSON.stringify({
    title: 'maintainer',
  }),
})

If the member already contains extension data, retrieve the current value, merge changes within your application layer, and submit the entire serialized string.

Return value

The Promise resolves with void once OpenIMServer updates the member extension data.

State changes after the call

A resolved Promise confirms that the extension string was saved. Connected clients receive onGroupMemberInfoChanged, at which point the UI updates the member's ex field matching groupID:userID. For complete member event handling, see Get group member list.

Was this page helpful?