SDKsiOS

Invite users to a group

Invite users to an iOS group.

Invoke inviteUserToGroup:reason:usersID:onSuccess:onFailure: to invite users to join a specified group (typically initiated by group owners and administrators):

Parameters

Parameter	Type	Required	Description
`groupID`	`NSString *`	Yes	Target group ID.
`reason`	`NSString *`	No	Invitation explanation or note.
`usersID`	`NSArray<NSString > `	Yes	List of user IDs to invite.

Code example

[[OIMManager manager] inviteUserToGroup:@"group_1001"
                                 reason:@"Inviting to project discussion"
                                usersID:@[@"user_001", @"user_002"]
                              onSuccess:^(NSArray<OIMGroupInviteResult *> *results) {
                                  for (OIMGroupInviteResult *item in results) {
                                      NSLog(@"user: %@, result: %ld", item.userID, (long)item.result);
                                  }
                              }
                              onFailure:^(NSInteger code, NSString *message) {
                                  NSLog(@"inviteUserToGroup failed: %ld %@", (long)code, message);
                              }];

Return value

The onSuccess callback delivers an array of invitation outcome records (NSArray<OIMGroupInviteResult *> *) specifying the processing status for each user.

State changes after the call

Invitation processing: A successful callback confirms the server accepted the invitation request. If join verification is enabled, users may need to accept before joining.
Event notification: Once members successfully enter the group, onGroupMemberAdded: is broadcast. The client updates the local member cache matching groupID:userID.
Re-query calibration: For listener configuration and member queries, refer to Group member queries overview.

Was this page helpful?