SDKsReact Native

Update a group nickname

OpenIM React Native SDK guide for update a group nickname.

Call setGroupMemberInfo() to update a member's group nickname.

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

Parameters

Parameter	Type	Required	Description
`groupID`	`string`	Yes	ID of the target group.
`userID`	`string`	Yes	User ID of the member whose nickname to update.
`nickname`	`string`	Yes	New nickname for the member in the group.

A group nickname applies only to this group and does not change the user's account nickname.

When the call completes, the group nickname is updated. Member profile changes trigger OnGroupMemberInfoChanged; see Get group members for event handling.

Was this page helpful?