Browse SDKs · Flutter
Platform
SDKsFlutter

Set group member nickname

Update the in-group display nickname for a specified member using the OpenIM Flutter SDK.

Copy

Modify a member's in-group nickname (group card display name) within a specific group:

Parameters

ParameterTypeRequiredDescription
groupIDStringYesTarget group ID.
userIDStringYesTarget member user ID.
nicknameStringYesNew in-group nickname to display for this member.

Code example

await OpenIM.iMManager.groupManager.setGroupMemberInfo(
  groupMembersInfo: SetGroupMemberInfo(
    groupID: groupID,
    userID: targetUserID,
    nickname: 'Project Lead',
  ),
);

An in-group nickname applies solely within the active group; it does not change the user's account-wide profile nickname. Modifying self or other members' nicknames is governed by server permissions. To update an account's global nickname, see Update self profile.

Return value

A successful Future indicates that the in-group nickname has been updated on the server.

State changes after the call

Connected clients in the group receive member profile update events. The client updates the local member record using groupID:userID as the key. For complete listener integration, see Retrieving group members overview.