<AgoraChatGroupManagerDelegate> Protocol Reference

#import <AgoraChatGroupManagerDelegate.h>

Inheritance diagram for <AgoraChatGroupManagerDelegate>:

Instance Methods
(void)	- groupInvitationDidReceive:groupName:inviter:message:
(void)	- groupInvitationDidAccept:invitee:
(void)	- groupInvitationDidDecline:invitee:reason:
(void)	- didJoinGroup:inviter:message:
(void)	- didLeaveGroup:reason:
(void)	- joinGroupRequestDidReceive:user:reason:
(void)	- joinGroupRequestDidDecline:reason:
(void)	- joinGroupRequestDidApprove:
(void)	- groupListDidUpdate:
(void)	- groupMuteListDidUpdate:addedMutedMembers:muteExpire:
(void)	- groupMuteListDidUpdate:removedMutedMembers:
(void)	- groupWhiteListDidUpdate:addedWhiteListMembers:
(void)	- groupWhiteListDidUpdate:removedWhiteListMembers:
(void)	- groupAllMemberMuteChanged:isAllMemberMuted:
(void)	- groupAdminListDidUpdate:addedAdmin:
(void)	- groupAdminListDidUpdate:removedAdmin:
(void)	- groupOwnerDidUpdate:newOwner:oldOwner:
(void)	- userDidJoinGroup:user:
(void)	- userDidLeaveGroup:user:
(void)	- groupAnnouncementDidUpdate:announcement:
(void)	- groupFileListDidUpdate:addedSharedFile:
(void)	- groupFileListDidUpdate:removedSharedFile:
(void)	- groupStateChanged:isDisabled:
(void)	- groupSpecificationDidUpdate:
(void)	- onAttributesChangedOfGroupMember:userId:attributes:operatorId:
(void)	- groupInvitationDidReceive:inviter:message:

Detailed Description

The group manager delegates.

Method Documentation

didJoinGroup:inviter:message:

- (void) didJoinGroup: (AgoraChatGroup *_Nonnull)  aGroup inviter: (NSString *_Nonnull)  aInviter message: (NSString *_Nullable)  aMessage

optional

Occurs when the SDK automatically joins the group.

If isAutoAcceptGroupInvitation in AgoraChatOptions is set as YES, when you receive a group invitation, the SDK automatically accepts the invitation and joins the group.

Needs to set the AgoraChatOptions's isAutoAcceptGroupInvitation property as YES.

Parameters

aGroup	The group instance.
aInviter	The inviter.
aMessage	The invite message.

didLeaveGroup:reason:

- (void) didLeaveGroup: (AgoraChatGroup *_Nonnull)  aGroup reason: (AgoraChatGroupLeaveReason)  aReason

optional

Occurs when the user leaves a group.

Parameters

aGroup	The group instance.
aReason	The reason for leaving the group.

groupAdminListDidUpdate:addedAdmin:

- (void) groupAdminListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup addedAdmin: (NSString *_Nonnull)  aAdmin

optional

Occurs when a group member is added to the admin list.

Parameters

aGroup	The group instance.
aAdmin	The group member added to the admin list.

groupAdminListDidUpdate:removedAdmin:

- (void) groupAdminListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup removedAdmin: (NSString *_Nonnull)  aAdmin

optional

Occurs when a groupmember is removed from the admin list.

Parameters

aGroup	The group instance.
aAdmin	The group member removed from the admin list.

groupAllMemberMuteChanged:isAllMemberMuted:

- (void) groupAllMemberMuteChanged: (AgoraChatGroup *_Nonnull)  aGroup isAllMemberMuted: (BOOL)  aMuted

optional

Occurs when the mute state of all group members changes.

Parameters

aGroup	The group instance.
aMuted	Whether all the group members are muted.

groupAnnouncementDidUpdate:announcement:

- (void) groupAnnouncementDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup announcement: (NSString *_Nullable)  aAnnouncement

optional

Occurs when the group announcement updates.

Parameters

aGroup	The group instance.
aAnnouncement	The group announcement.

groupFileListDidUpdate:addedSharedFile:

- (void) groupFileListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup addedSharedFile: (AgoraChatGroupSharedFile *_Nonnull)  aSharedFile

optional

Occurs when the group shared file is uploaded.

Parameters

aGroup	The group instance.
aSharedFile	The shared file.

groupFileListDidUpdate:removedSharedFile:

- (void) groupFileListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup removedSharedFile: (NSString *_Nonnull)  aFileId

optional

Occurs when the shared file of the group is removed.

Parameters

aGroup	The group instance.
aFileId	The ID of the shared file.

groupInvitationDidAccept:invitee:

- (void) groupInvitationDidAccept: (AgoraChatGroup *_Nonnull)  aGroup invitee: (NSString *_Nonnull)  aInvitee

optional

This callback is triggered when the peer user accepts the group invitation sent by the local user. For example, user B accepts the invitation of user A, user A receives this callback.

Parameters

aGroup	The group instance.
aInvitee	The user that accepts the invitation.

groupInvitationDidDecline:invitee:reason:

- (void) groupInvitationDidDecline: (AgoraChatGroup *_Nonnull)  aGroup invitee: (NSString *_Nonnull)  aInvitee reason: (NSString *_Nullable)  aReason

optional

Occurs when the group invitation is declined.

This callback is triggered when a peer user declines the group invitation sent by the local user. For example, user B declines the group invitation sent by user A, user A receives this callback.

Parameters

aGroup	The group instance.
aInvitee	The invitee.
aReason	The reason for declining the group invitation.

groupInvitationDidReceive:groupName:inviter:message:

- (void) groupInvitationDidReceive: (NSString *_Nonnull)  aGroupId groupName: (NSString *_Nonnull)  aGroupName inviter: (NSString *_Nonnull)  aInviter message: (NSString *_Nullable)  aMessage

optional

Occurs when the user receives a group invitation.

This callback is triggered by a peer user sending a group invitation. For example, after user A sends user B a group invitation, user B receives this callback.

Parameters

aGroupId	The group ID.
aGroupName	The group name.
aInviter	The user sending the group invitation.
aMessage	The invitation message.

groupInvitationDidReceive:inviter:message:

- (void) groupInvitationDidReceive: (NSString *)  aGroupId inviter: (NSString *)  aInviter message: ("Use -groupInvitationDidReceive:groupName:inviter:message: instead")  __deprecated_msg

optional

Occurs when the user receives a group invitation.

This callback is triggered by a peer user sending a group invitation. For example, after user A sends user B a group invitation, user B receives this callback.

Deprecated. Please use groupInvitationDidReceive:groupName:inviter:message: instead.

Parameters

aGroupId	The group ID.
aInviter	The user sending the group invitation.
aMessage	The invitation message.

groupListDidUpdate:

- (void) groupListDidUpdate: (NSArray< AgoraChatGroup * > *_Nonnull)  aGroupList

optional

Occurs when the group list updates.

Parameters

aGroupList

The group NSArray. See <AgoraChatGroup>.

groupMuteListDidUpdate:addedMutedMembers:muteExpire:

- (void) groupMuteListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup addedMutedMembers: (NSArray< NSString * > *_Nonnull)  aMutedMembers muteExpire: (NSInteger)  aMuteExpire

optional

Occurs when the group members are added to the group mute list.

Parameters

aGroup	The group instance.
aMutedMembers	The group members that are added to the mute list.
aMuteExpire	The time when the mute state expires. This parameter is not available at the moment.

groupMuteListDidUpdate:removedMutedMembers:

- (void) groupMuteListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup removedMutedMembers: (NSArray< NSString * > *_Nonnull)  aMutedMembers

optional

Occurs when the group members are removed from the mute list.

Parameters

aGroup	The group instance.
aMutedMembers	The group members removed from the mute list.

groupOwnerDidUpdate:newOwner:oldOwner:

- (void) groupOwnerDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup newOwner: (NSString *_Nonnull)  aNewOwner oldOwner: (NSString *_Nonnull)  aOldOwner

optional

Occurs when the group owner changes.

Parameters

aGroup	The group instance.
aNewOwner	The new owner.
aOldOwner	The old owner.

groupSpecificationDidUpdate:

- (void) groupSpecificationDidUpdate: (AgoraChatGroup *)  aGroup

optional

Occurs when the group specification update,Need to call for details of the API (IAgoraChatGroupManager.h : getGroupSpecificationFromServerWithId) to get the latest information

Parameters

aGroup

The group instance.

groupStateChanged:isDisabled:

- (void) groupStateChanged: (AgoraChatGroup *)  aGroup isDisabled: (BOOL)  aDisabled

optional

Occurs when the disabled state of group changes.

Parameters

aGroup	The group instance.
aDisabled	Whether the group is disabled.

groupWhiteListDidUpdate:addedWhiteListMembers:

- (void) groupWhiteListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup addedWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers

optional

Occurs when the group members are added to the allowlist.

Parameters

aGroup	The group instance.
aMembers	The group members added to the allowlist.

groupWhiteListDidUpdate:removedWhiteListMembers:

- (void) groupWhiteListDidUpdate: (AgoraChatGroup *_Nonnull)  aGroup removedWhiteListMembers: (NSArray< NSString * > *_Nonnull)  aMembers

optional

Occurs when the group members are removed from the allowlist.

Parameters

aGroup	The group instance.
aMembers	The group members removed from the allowlist.

joinGroupRequestDidApprove:

- (void) joinGroupRequestDidApprove: (AgoraChatGroup *_Nonnull)  aGroup

optional

If you set the group type as AgoraChatGroupStylePublicJoinNeedApproval, when the group owner approves the join request, the user that sends the request receives this callback.

Parameters

aGroup

The group instance.

joinGroupRequestDidDecline:reason:

- (void) joinGroupRequestDidDecline: (NSString *_Nonnull)  aGroupId reason: (NSString *_Nullable)  aReason

optional

If you set the group type as AgoraChatGroupStylePublicJoinNeedApproval, when the group owner declines a join request, the user that sends the request receives this callback.

Parameters

aGroupId	The group ID.
aReason	The reason for declining the join request.

joinGroupRequestDidReceive:user:reason:

- (void) joinGroupRequestDidReceive: (AgoraChatGroup *_Nonnull)  aGroup user: (NSString *_Nonnull)  aUsername reason: (NSString *_Nullable)  aReason

optional

Occurs when the group owner receives a join request.

If you set the group type as AgoraChatGroupStylePublicJoinNeedApproval, when a user requests to join the group, the group owner receives this callback.

Parameters

aGroup	The group instance.
aUsername	The user that sends the join request.
aReason	The extra information for joining the group.

onAttributesChangedOfGroupMember:userId:attributes:operatorId:

- (void) onAttributesChangedOfGroupMember: (NSString *_Nonnull)  groupId userId: (NSString *_Nonnull)  userId attributes: (NSDictionary< NSString *, NSString * > *_Nullable)  attributes operatorId: (NSString *_Nonnull)  operatorId

optional

Occurs when a custom attribute(s) of a group member is/are changed.

Parameters

groupId	The group ID.
userId	The user ID of the group member whose custom attributes are changed.
attributes	The modified custom attributes, in key-value format.
operatorId	The user ID of the operator.

userDidJoinGroup:user:

- (void) userDidJoinGroup: (AgoraChatGroup *_Nonnull)  aGroup user: (NSString *_Nonnull)  aUsername

optional

Occurs when a user joins a group.

Parameters

aGroup	The group instance.
aUsername	The user that joins the group.

userDidLeaveGroup:user:

- (void) userDidLeaveGroup: (AgoraChatGroup *_Nonnull)  aGroup user: (NSString *_Nonnull)  aUsername

optional

Occurs when a user leaves the group.

Parameters

aGroup	The group instance.
aUsername	The user that leaves the group.

---

The documentation for this protocol was generated from the following file:

• AgoraChat.framework/Headers/AgoraChatGroupManagerDelegate.h