SDKsHarmonyOSEnterprise

Set group member extension

Set custom business extension data for a specified group member.

ex is an opaque string; the SDK does not automatically merge JSON objects. When multiple business modules share this field, the application layer must preserve other namespaces.

Code example

import sdk, { SetGroupMemberInfoReq } from '@openimsdk/imsdk';

const request: SetGroupMemberInfoReq = {
  groupID: groupID,
  userID: targetUserID,
  ex: JSON.stringify({ title: 'maintainer' }),
};
await sdk.setGroupMemberInfo(request);

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group identifier.
`userID`	`string`	Yes	Target member user ID.
`ex`	`string`	Yes	Custom extension string.

Return value

Returns a Promise that resolves to void when the extension field is updated on the server.

Use JSON string serialization only if your business logic expects JSON; otherwise, treat ex as an arbitrary string. After the Promise resolves, the SDK triggers a group member info changed event; clients update the member record matching groupID:userID. For complete event listeners, see Retrieve group member list.

Was this page helpful?

Code example

Parameters

Return value

State changes after the call