SDKsReact Native

Update group member nickname

Update the group-specific nickname of a group member using the OpenIM React Native SDK.

Update a member's group-specific nickname (group display name):

await OpenIMSDK.setGroupMemberInfo({
  groupID: 'group-001',
  userID: 'user-002',
  nickname: 'Project owner',
});

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	Target group ID.
`userID`	`string`	Yes	User ID of the member whose group nickname is being updated.
`nickname`	`string`	Yes	New group-specific nickname for the member.

A group nickname applies solely within the specified group and does not alter the user's account-level global nickname.

Return value

A resolved Promise confirms that the group member nickname was successfully updated on the server.

Member profile updates emit the OnGroupMemberInfoChanged event carrying the latest member record. Reconcile the member's nickname using the composite key groupID:userID. For complete event listeners, see Get group member list by page.

Was this page helpful?