SDKsiOS

Update a group nickname

Update a member’s nickname within an iOS group.

Invoke setGroupMemberNickname:userID:groupNickname:onSuccess:onFailure: to update a member's group-specific display nickname:

Parameters

Parameter	Type	Required	Description
`groupID`	`NSString *`	Yes	Target group ID.
`userID`	`NSString *`	Yes	User ID of the target group member.
`groupNickname`	`NSString *`	Yes	New group-specific nickname.

Code example

[[OIMManager manager] setGroupMemberNickname:@"group_1001"
                                      userID:@"user_003"
                               groupNickname:@"Project Lead - Alex"
                                   onSuccess:^(NSString * _Nullable data) {
                                       NSLog(@"setGroupMemberNickname success");
                                   }
                                   onFailure:^(NSInteger code, NSString *message) {
                                       NSLog(@"setGroupMemberNickname failed: %ld %@", (long)code, message);
                                   }];

Return value

The onSuccess callback returns confirmation when the server accepts the nickname update.

State changes after the call

Local state update: The client updates the member's group nickname matching groupID:userID. This nickname is scoped strictly to the current group and does not alter the user's global profile name.
Event notification: Updated member details broadcast across active client sessions through onGroupMemberInfoChanged:.
Re-query calibration: For member queries, refer to Group member queries overview.

Was this page helpful?