Manage groups

---

ZEGOCLOUD's In-app Chat (the ZIM SDK) provides the capability of group management, allowing you to create a group, ungroup, join and leave a group, and maintain the group relation chain.

With the group management feature, you can create different types of group chats as needed, such as colleague groups, social groups, fan groups, and more.

Prerequisites

• Create a project in ZEGOCLOUD Console. Then, contact Technical Support to activate the In-app Chat service, and get the AppID and ServerSecret for SDK integration. The ZIM service permission is not enabled by default. Before using it, please activate the ZIM service by yourself in ZEGOCLOUD Console (for details, please refer to Project Management - In-app Chat), if you cannot activate the ZIM service, please contact ZEGOCLOUD technical support to activate it.
• Get the Token that SDK required for login authentication. For details, see Authentication.
• Integrate the ZIM SDK. For details, see the Integrate the SDK chapter of Send and receive messages.

Create a group

Let's suppose we have Client A and other client users. The following shows how Client A creates the group, how other client users join and leave the room.

After Client A logs in, he can call the createGroup method to create a new group, and he can be told whether the group is created successfully through the callback ZIMGroupCreatedCallback. For related error codes, see Error codes.

Client A automatically becomes the group owner of the group. Other client users can join the group with a correct groupID.

Sample method call

- (void)createGroup:(ZIMGroupInfo *)groupInfo
            userIDs:(NSArray<NSString *> *)userIDs
             config:(ZIMGroupAdvancedConfig *)config
           callback:(ZIMGroupCreatedCallback)callback;

Parameter description

Sample code

// Create a group. 
[zim createGroup:myGroupID userIDs:userIDs callback:^(ZIMGroupFullInfo * _Nonnull groupInfo, NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
        //Imeplement the event callback for creating a group here.
 }];

Join a group

For a client user to join a group, choose either of the following methods:

• Join a group directly (actively):

  To join a group directly, call the joinGroup method with the groupID (an existing groupID). All group members including the client user himself receive a notification through the callback groupMemberStateChanged after the client user joins the group successfully.

• Join a group by invited by a group member (passively):

  To invite a new member into the group, call the inviteUsersIntoGroup method with the groupID (an existing groupID), and userIDList (the ID of the user you want to invite). All group members including the client user himself receive a notification through the callback groupMemberStateChanged after the client user joins the group successfully.

Join a group directly (actively)

• Sample method call

  - (void)joinGroup:(NSString *)groupID callback:(ZIMGroupJoinedCallback)callback;

• Parameter description

Join a group by being invited by a group member (passively)

• Sample method call

  - (void)inviteUsersIntoGroup:(NSArray<NSString *> *)userIDs
                       groupID:(NSString *)groupID
                      callback:(ZIMGroupUsersInvitedCallback)callback;

• Parameter description

Sample code

// Join a group directly.
[zim joinGroup:GroupID callback:^(ZIMGroupFullInfo * _Nonnull groupInfo, ZIMError * _Nonnull errorInfo) {
    //Implement the event callback for joining a group here.
}];


// Join a group by being invited by a group member.
[zim inviteUsersIntoGroup:userIDs groupID:groupID callback:^(NSArray<ZIMGroupMemberInfo *> * _Nonnull userList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
    //Implement the event callback for inviting a user to join to the current group here.
 }];

Leave the group

For a client user to leave a group, choose either of the following methods:

• Leave the group directly (actively):

  To leave the group, call the leaveGroup method with the groupID (an existing groupID). All group members including the client user himself receive a notification through the callback groupMemberStateChanged after the client user leaves the group successfully.

• Leave the group by removed by the group owner (passively):

  To remove a group member from the group, call the kickGroupMembers method with the groupID (an existing groupID), and userIDList (the ID of the user you want to remove). All group members including the client user himself receive a notification through the callback groupMemberStateChanged after the client user was removed from the group successfully.

Leave the group directly (actively)

• Sample method call

  - (void)leaveGroup:(NSString *)groupID callback:(ZIMGroupLeftCallback)callback;

• Parameter description

Leave the group by removed by the group owner (passively)

• Sample method call

  - (void)kickGroupMembers:(NSArray<NSString *> *)userIDs
               groupID:(NSString *)groupID
              callback:(ZIMGroupMemberKickedCallback)callback;

• Parameter description

Sample code

// Leave the group directly (actively).
[zim leaveGroup:groupID callback:^(ZIMError * _Nonnull errorInfo) {
        //Implement the event callback for leaving the group actively here.
}];

// Leave the group by removed by the group owner (passively).
[zim kickGroupMembers:userIDs groupID:groupID callback:^(NSArray<NSString *> * _Nonnull kickedUserIDList, NSArray<ZIMErrorUserInfo *> * _Nonnull errorUserList, ZIMError * _Nonnull errorInfo) {
        //Implement the event callback of removing a group member here. 
}];

Ungroup

For a group owner to ungroup, call the dismissGroup method. All group members receive a notification through the callback groupStateChanged when ungroup operation succeeds.

Sample method call

- (void)dismissGroup:(NSString *)groupID callback:(ZIMGroupDismissedCallback)callback;

• Parameter description

Sample code

// The group owner to ungroup.
[zim dismissGroup:groupID callback:^(ZIMError * _Nonnull errorInfo) {
        //Implement the event callback for ungroup here.
 }];

Get the list of joined groups

To know what groups you have joined after login, call the queryGroupList method.

Sample method call

- (void)queryGroupList:(ZIMGroupListQueriedCallback)callback;

• Parameter description

Sample code

// Get the list of joined groups.
[zim queryGroupListByGroupID:^(NSArray<ZIMGroupInfo *> * _Nonnull groupList, ZIMError * _Nonnull errorInfo) {
    //Implement the event callback for querying the list of joined groups.
}];