agora_chat_SDK  3.8.2
Instance Methods | List of all members
<AgoraGroupManagerDelegate> Protocol Reference

#import <AgoraGroupManagerDelegate.h>

Inheritance diagram for <AgoraGroupManagerDelegate>:

Instance Methods

(void) - groupInvitationDidReceive: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) - didReceiveGroupInvitation:inviter:message:
 
(void) - didReceiveAcceptedGroupInvitation:invitee:
 
(void) - didReceiveDeclinedGroupInvitation:invitee:reason:
 
(void) - didJoinedGroup:inviter:message:
 
(void) - didReceiveLeavedGroup:reason:
 
(void) - didReceiveJoinGroupApplication:applicant:reason:
 
(void) - didReceiveDeclinedJoinGroup:reason:
 
(void) - didReceiveAcceptedJoinGroup:
 
(void) - didUpdateGroupList:
 

Detailed Description

Delegate

Method Documentation

- (void) didJoinedGroup: (AgoraGroup *)  aGroup
inviter: (NSString *)  aInviter
message: ("Use -didJoinGroup:inviter:message: instead")  __deprecated_msg 
optional

User B will receive this callback after SDK automatically accept user A's group invitation. Set AgoraOptions's isAutoAcceptGroupInvitation property to YES for this delegate method

Parameters
aGroupGroup instance
aInviterInviter
aMessageInvite message
- (void) didJoinGroup: (AgoraGroup *)  aGroup
inviter: (NSString *)  aInviter
message: (NSString *)  aMessage 
optional

Delegate method will be invoked after SDK automatically accepted the group invitation

User B will receive this callback after SDK automatically accept user A's group invitation, need set AgoraOptions's isAutoAcceptGroupInvitation property to YES

Parameters
aGroupGroup instance
aInviterInviter
aMessageInvite message
- (void) didLeaveGroup: (AgoraGroup *)  aGroup
reason: (AgoraGroupLeaveReason)  aReason 
optional

Delegate method will be invoked when user leaves a group

Parameters
aGroupGroup instance
aReasonLeave reason
- (void) didReceiveAcceptedGroupInvitation: (AgoraGroup *)  aGroup
invitee: ("Use -groupInvitationDidAccept:invitee: instead")  __deprecated_msg 
optional

Delegate method will be invoked when a group invitation is accepted

After user B accepted user A‘s group invitation, user A will receive this callback

Parameters
aGroupGroup instance
aInviteeInvitee
- (void) didReceiveAcceptedJoinGroup: ("Use -joinGroupRequestDidApprove: instead")  __deprecated_msg
optional

User A will receive this callback after group's owner accepted it's application, group's style is AgoraGroupStylePublicJoinNeedApproval

Parameters
aGroupGroup instance
- (void) didReceiveDeclinedGroupInvitation: (AgoraGroup *)  aGroup
invitee: (NSString *)  aInvitee
reason: ("Use -groupInvitationDidDecline:invitee:reason: instead")  __deprecated_msg 
optional

Delegate method will be invoked when a group invitation is declined

After user B declined user A's group invitation, user A will receive the callback

Parameters
aGroupGroup instance
aInviteeInvitee
aReasonDecline reason
- (void) didReceiveDeclinedJoinGroup: (NSString *)  aGroupId
reason: ("Use -joinGroupRequestDidDecline:reason: instead")  __deprecated_msg 
optional

User A will receive this callback after group's owner declined the join group request

Parameters
aGroupIdGroup id
aReasonDecline reason
- (void) didReceiveGroupInvitation: (NSString *)  aGroupId
inviter: (NSString *)  aInviter
message: ("Use -groupInvitationDidReceive:inviter:message: instead")  __deprecated_msg 
optional

Delegate method will be invoked when user receives a group invitation

After user A invites user B into the group, user B will receive this callback

Parameters
aGroupIdThe group ID
aInviterInviter
aMessageInvite message
- (void) didReceiveJoinGroupApplication: (AgoraGroup *)  aGroup
applicant: (NSString *)  aApplicant
reason: ("Use -joinGroupRequestDidReceive:user:reason: instead")  __deprecated_msg 
optional

Group's owner receive user's applicaton of joining group, group's style is AgoraGroupStylePublicJoinNeedApproval

Parameters
aGroupGroup
aApplicantThe applicant
aReasonApplicant's ancillary information
- (void) didReceiveLeavedGroup: (AgoraGroup *)  aGroup
reason: ("Use -didLeaveGroup:reason: instead")  __deprecated_msg 
optional

Callback of leave group

Parameters
aGroupGroup instance
aReasonLeave reason
- (void) didUpdateGroupList: ("Use -groupListDidUpdate: instead")  __deprecated_msg
optional

Group List changed

Parameters
aGroupListGroup list<AgoraGroup>
- (void) groupAdminListDidUpdate: (AgoraGroup *)  aGroup
addedAdmin: (NSString *)  aAdmin 
optional

User is added to the admin list

Parameters
aGroupGroup instance
aAdminUser to be added to adminList
- (void) groupAdminListDidUpdate: (AgoraGroup *)  aGroup
removedAdmin: (NSString *)  aAdmin 
optional

User is removed to the admin list

Parameters
aGroupGroup instance
aAdminUser to be removed from adminList
- (void) groupAllMemberMuteChanged: (AgoraGroup *)  aGroup
isAllMemberMuted: (BOOL)  aMuted 
optional

Group members are all muted

Parameters
aGroupGroup instance
aMutedWhether all member be muted
- (void) groupAnnouncementDidUpdate: (AgoraGroup *)  aGroup
announcement: (NSString *)  aAnnouncement 
optional

Delegate method will be invoked when a user update the announcement from a group.

Parameters
aGroupGroup instance
aAnnouncementGroup announcement
- (void) groupFileListDidUpdate: (AgoraGroup *)  aGroup
addedSharedFile: (AgoraGroupSharedFile *)  aSharedFile 
optional

Delegate method will be invoked when a user upload share file to a group.

Parameters
aGroupGroup instance
aSharedFileSharefile
- (void) groupFileListDidUpdate: (AgoraGroup *)  aGroup
removedSharedFile: (NSString *)  aFileId 
optional

Delegate method will be invoked when a user remove share file from a group.

Parameters
aGroupGroup instance
aFileIdSharefile ID
- (void) groupInvitationDidAccept: (AgoraGroup *)  aGroup
invitee: (NSString *)  aInvitee 
optional

Delegate method will be invoked when the group invitation is accepted

After user B accepted user A‘s group invitation, user A will receive this callback

Parameters
aGroupUser joined group
aInviteeInvitee
- (void) groupInvitationDidDecline: (AgoraGroup *)  aGroup
invitee: (NSString *)  aInvitee
reason: (NSString *)  aReason 
optional

Delegate method will be invoked when the group invitation is declined.

After user B declined user A's group invitation, user A will receive the callback

Parameters
aGroupGroup instance
aInviteeInvitee
aReasonDecline reason
- (void) groupInvitationDidReceive: (NSString *)  aGroupId
inviter: (NSString *)  aInviter
message: (NSString *)  aMessage 
optional

Delegate method will be invoked when receiving a group invitation

After user A invites user B into the group, user B will receive this callback

Parameters
aGroupIdThe group ID
aInviterInviter
aMessageInvitation message
- (void) groupListDidUpdate: (NSArray *)  aGroupList
optional

Group List updated

Parameters
aGroupListGroup NSArray<AgoraGroup>
- (void) groupMuteListDidUpdate: (AgoraGroup *)  aGroup
addedMutedMembers: (NSArray *)  aMutedMembers
muteExpire: (NSInteger)  aMuteExpire 
optional

Users are added to the mute list

Parameters
aGroupGroup instance
aMutedMembersUsers to be added
aMuteExpireMute expire, not available at this time
- (void) groupMuteListDidUpdate: (AgoraGroup *)  aGroup
removedMutedMembers: (NSArray *)  aMutedMembers 
optional

Users are removed from the mute list

Parameters
aGroupGroup instance
aMutedMembersUsers to be removed from mute list
- (void) groupOwnerDidUpdate: (AgoraGroup *)  aGroup
newOwner: (NSString *)  aNewOwner
oldOwner: (NSString *)  aOldOwner 
optional

Owner is updated

Parameters
aGroupGroup instance
aNewOwnerNew Owner
aOldOwnerOld Owner
- (void) groupWhiteListDidUpdate: (AgoraGroup *)  aGroup
addedWhiteListMembers: (NSArray *)  aMembers 
optional

Users are added to the white list

Parameters
aGroupGroup instance
aMembersUsers to be added to whiteList
- (void) groupWhiteListDidUpdate: (AgoraGroup *)  aGroup
removedWhiteListMembers: (NSArray *)  aMembers 
optional

Users are removed from the white list

Parameters
aGroupGroup instance
aMembersUsers to be removed from whiteList
- (void) joinGroupRequestDidApprove: (AgoraGroup *)  aGroup
optional

Delegate method will be invoked when the group owner approves a join group request

User A will receive this callback after group's owner approve the group request, group's style is AgoraGroupStylePublicJoinNeedApproval

Parameters
aGroupGroup instance
- (void) joinGroupRequestDidDecline: (NSString *)  aGroupId
reason: (NSString *)  aReason 
optional

Delegate method will be invoked when the group owner declines a join group request

User A will receive this callback after group's owner declined the group request, group's style is AgoraGroupStylePublicJoinNeedApproval

Parameters
aGroupIdGroup id
aReasonDecline reason
- (void) joinGroupRequestDidReceive: (AgoraGroup *)  aGroup
user: (NSString *)  aUsername
reason: (NSString *)  aReason 
optional

Delegate method will be invoked when the group owner receives a group request and group's style is AgoraGroupStylePublicJoinNeedApproval

Parameters
aGroupGroup instance
aUsernameThe user initialized the group join request
aReasonApplicant's ancillary information
- (void) userDidJoinGroup: (AgoraGroup *)  aGroup
user: (NSString *)  aUsername 
optional

Delegate method will be invoked when a user joins a group.

Parameters
aGroupJoined group
aUsernameThe user who joined group
- (void) userDidLeaveGroup: (AgoraGroup *)  aGroup
user: (NSString *)  aUsername 
optional

Delegate method will be invoked when a user leaves a group.

Parameters
aGroupLeft group
aUsernameThe user who leaved group

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