<IAgoraGroupManager> Protocol Reference

#import <IAgoraGroupManager.h>

Inheritance diagram for <IAgoraGroupManager>:

Instance Methods
(void)	- addDelegate:delegateQueue:
(void)	- removeDelegate:
(NSArray *)	- getJoinedGroups
(NSArray *)	- getGroupsWithoutPushNotification:
(NSArray *)	- getJoinedGroupsFromServerWithPage:pageSize:error:
(void)	- getJoinedGroupsFromServerWithPage:pageSize:completion:
(AgoraCursorResult *)	- getPublicGroupsFromServerWithCursor:pageSize:error:
(void)	- getPublicGroupsFromServerWithCursor:pageSize:completion:
(AgoraGroup *)	- searchPublicGroupWithId:error:
(void)	- searchPublicGroupWithId:completion:
(AgoraGroup *)	- createGroupWithSubject:description:invitees:message:setting:error:
(void)	- createGroupWithSubject:description:invitees:message:setting:completion:
(AgoraGroup *)	- getGroupSpecificationFromServerWithId:error:
(AgoraGroup *)	- getGroupSpecificationFromServerWithId:fetchMembers:error:
(void)	- getGroupSpecificationFromServerWithId:completion:
(void)	- getGroupSpecificationFromServerWithId:fetchMembers:completion:
(AgoraCursorResult *)	- getGroupMemberListFromServerWithId:cursor:pageSize:error:
(void)	- getGroupMemberListFromServerWithId:cursor:pageSize:completion:
(NSArray *)	- getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:
(void)	- getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getGroupMuteListFromServerWithId:pageNumber:pageSize:error:
(void)	- getGroupMuteListFromServerWithId:pageNumber:pageSize:completion:
(NSArray *)	- getGroupFileListWithId:pageNumber:pageSize:error:
(void)	- getGroupFileListWithId:pageNumber:pageSize:completion:
(NSArray *)	- getGroupWhiteListFromServerWithId:error:
(void)	- getGroupWhiteListFromServerWithId:completion:
(BOOL)	- isMemberInWhiteListFromServerWithGroupId:error:
(void)	- isMemberInWhiteListFromServerWithGroupId:completion:
(NSString *)	- getGroupAnnouncementWithId:error:
(void)	- getGroupAnnouncementWithId:completion:
(AgoraGroup *)	- addOccupants:toGroup:welcomeMessage:error:
(void)	- addMembers:toGroup:message:completion:
(AgoraGroup *)	- removeOccupants:fromGroup:error:
(void)	- removeMembers:fromGroup:completion:
(AgoraGroup *)	- blockOccupants:fromGroup:error:
(void)	- blockMembers:fromGroup:completion:
(AgoraGroup *)	- unblockOccupants:forGroup:error:
(void)	- unblockMembers:fromGroup:completion:
(AgoraGroup *)	- changeGroupSubject:forGroup:error:
(void)	- updateGroupSubject:forGroup:completion:
(AgoraGroup *)	- changeDescription:forGroup:error:
(void)	- updateDescription:forGroup:completion:
(void)	- leaveGroup:error:
(void)	- leaveGroup:completion:
(AgoraError *)	- destroyGroup:
(void)	- destroyGroup:finishCompletion:
(AgoraGroup *)	- blockGroup:error:
(void)	- blockGroup:completion:
(AgoraGroup *)	- unblockGroup:error:
(void)	- unblockGroup:completion:
(AgoraGroup *)	- updateGroupOwner:newOwner:error:
(void)	- updateGroupOwner:newOwner:completion:
(AgoraGroup *)	- addAdmin:toGroup:error:
(void)	- addAdmin:toGroup:completion:
(AgoraGroup *)	- removeAdmin:fromGroup:error:
(void)	- removeAdmin:fromGroup:completion:
(AgoraGroup *)	- muteMembers:muteMilliseconds:fromGroup:error:
(void)	- muteMembers:muteMilliseconds:fromGroup:completion:
(AgoraGroup *)	- unmuteMembers:fromGroup:error:
(void)	- unmuteMembers:fromGroup:completion:
(AgoraGroup *)	- muteAllMembersFromGroup:error:
(void)	- muteAllMembersFromGroup:completion:
(AgoraGroup *)	- unmuteAllMembersFromGroup:error:
(void)	- unmuteAllMembersFromGroup:completion:
(AgoraGroup *)	- addWhiteListMembers:fromGroup:error:
(void)	- addWhiteListMembers:fromGroup:completion:
(AgoraGroup *)	- removeWhiteListMembers:fromGroup:error:
(void)	- removeWhiteListMembers:fromGroup:completion:
(void)	- uploadGroupSharedFileWithId:filePath:progress:completion:
(void)	- downloadGroupSharedFileWithId:filePath:sharedFileId:progress:completion:
(AgoraGroup *)	- removeGroupSharedFileWithId:sharedFileId:error:
(void)	- removeGroupSharedFileWithId:sharedFileId:completion:
(AgoraGroup *)	- updateGroupAnnouncementWithId:announcement:error:
(void)	- updateGroupAnnouncementWithId:announcement:completion:
(AgoraGroup *)	- updateGroupExtWithId:ext:error:
(void)	- updateGroupExtWithId:ext:completion:
(AgoraGroup *)	- joinPublicGroup:error:
(void)	- joinPublicGroup:completion:
(AgoraGroup *)	- applyJoinPublicGroup:message:error:
(void)	- requestToJoinPublicGroup:message:completion:
(AgoraError *)	- acceptJoinApplication:applicant:
(void)	- approveJoinGroupRequest:sender:completion:
(AgoraError *)	- declineJoinApplication:applicant:reason:
(void)	- declineJoinGroupRequest:sender:reason:completion:
(AgoraGroup *)	- acceptInvitationFromGroup:inviter:error:
(void)	- acceptInvitationFromGroup:inviter:completion:
(AgoraError *)	- declineInvitationFromGroup:inviter:reason:
(void)	- declineGroupInvitation:inviter:reason:completion:
(AgoraError *)	- ignoreGroupPush:ignore:
(void)	- updatePushServiceForGroup:isPushEnabled:completion:
(AgoraError *)	- ignoreGroupsPush:ignore:
(void)	- updatePushServiceForGroups:isPushEnabled:completion:
(NSArray *)	- getMyGroupsFromServerWithError:
(void)	- getJoinedGroupsFromServerWithCompletion:
(AgoraGroup *)	- fetchGroupInfo:includeMembersList:error:
(void)	- getGroupSpecificationFromServerByID:includeMembersList:completion:
(NSArray *)	- fetchGroupBansList:error:
(void)	- getGroupBlackListFromServerByID:completion:
(AgoraGroup *)	- destroyGroup:error:
(void)	- destroyGroup:completion:
(void)	- addDelegate:
("Use -getJoinedGroups")	- __deprecated_msg
("Use -getJoinedGroups")	- __deprecated_msg
("Use -getGroupsWithoutPushNotification")	- __deprecated_msg
(void)	- asyncGetMyGroupsFromServer:failure:
(void)	- asyncGetPublicGroupsFromServerWithCursor:pageSize:success:failure:
(void)	- asyncSearchPublicGroupWithId:success:failure:
(void)	- asyncCreateGroupWithSubject:description:invitees:message:setting:success:failure:
(void)	- asyncFetchGroupInfo:includeMembersList:success:failure:
(void)	- asyncFetchGroupBansList:success:failure:
(void)	- asyncAddOccupants:toGroup:welcomeMessage:success:failure:
(void)	- asyncRemoveOccupants:fromGroup:success:failure:
(void)	- asyncBlockOccupants:fromGroup:success:failure:
(void)	- asyncUnblockOccupants:forGroup:success:failure:
(void)	- asyncChangeGroupSubject:forGroup:success:failure:
(void)	- asyncChangeDescription:forGroup:success:failure:
(void)	- asyncLeaveGroup:success:failure:
(void)	- asyncDestroyGroup:success:failure:
(void)	- asyncBlockGroup:success:failure:
(void)	- asyncUnblockGroup:success:failure:
(void)	- asyncJoinPublicGroup:success:failure:
(void)	- asyncApplyJoinPublicGroup:message:success:failure:
(void)	- asyncAcceptJoinApplication:applicant:success:failure:
(void)	- asyncDeclineJoinApplication:applicant:reason:success:failure:
(void)	- asyncAcceptInvitationFromGroup:inviter:success:failure:
(void)	- asyncDeclineInvitationFromGroup:inviter:reason:success:failure:
(void)	- asyncIgnoreGroupPush:ignore:success:failure:

Detailed Description

IAgoraGroupManager.h This protocol defines the group operations

Author

Hyphenate

Version

3.00

Group operations

Method Documentation

- ("Use -getJoinedGroups") __deprecated_msg

required

Get all groups, will load from DB if not exist in memory

Returns

Group list<AgoraGroup>

- ("Use -getJoinedGroups") __deprecated_msg

required

Load all groups from DB, will update group list in memory after loading

Returns

Group list<AgoraGroup>

- ("Use -getGroupsWithoutPushNotification") __deprecated_msg

required

Get ID list of groups which block push from memory

Returns

Group id list<NSString>

- (void) acceptInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Accept a group invitation

Parameters

aGroupId	Group id
aUsername	Inviter
aCompletionBlock	The callback block of completion

- (AgoraGroup *) acceptInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername error: (AgoraError **)  pError

required

Accept a group invitation

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aUsername	Inviter
pError	Error

Returns

Joined group instance

- (AgoraError *) acceptJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername

required

Accept a group request, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aUsername	The applicant

Returns

Error

- (void) addAdmin: (NSString *)  aAdmin toGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Add group admin, need Owner permissions

Parameters

aAdmin	Admin
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) addAdmin: (NSString *)  aAdmin toGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Add group admin, need Owner permissions

Synchronization method will block the current thread

Parameters

aAdmin	Admin
aGroupId	Group id
pError	Error

Returns

Group instance

- (void) addDelegate: (3_1_0)  (3_2_2)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager addDelegate:delegateQueue:]

required

Add delegate

Parameters

aDelegate

Delegate

- (void) addDelegate: (id< AgoraGroupManagerDelegate >)  aDelegate delegateQueue: (dispatch_queue_t)  aQueue

required

Add delegate

Parameters

aDelegate	Delegate
aQueue	(optional) The queue of calling delegate methods. Pass in nil to run on main thread.

- (void) addMembers: (NSArray *)  aUsers toGroup: (NSString *)  aGroupId message: (NSString *)  aMessage completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Invite User to join a group

Parameters

aUsers	Invited users
aGroupId	Group id
aMessage	Welcome message
aCompletionBlock	The callback block of completion

- (AgoraGroup *) addOccupants: (NSArray *)  aOccupants toGroup: (NSString *)  aGroupId welcomeMessage: (NSString *)  aWelcomeMessage error: (AgoraError **)  pError

required

Invite User to join a group

Synchronization method will block the current thread

Parameters

aOccupants	Invited users
aGroupId	Group id
aWelcomeMessage	Welcome message
pError	Error

Returns

AgoraGroup Group instance, return nil if fail

- (void) addWhiteListMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

add white list members, need Owner / Admin permissions

Parameters

aMembers	The list of whitelist, type is <NSString>
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) addWhiteListMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

add white list members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The list of whitelist, type is <NSString>
aGroupId	Group id
pError	Error

Returns

Group instance

- (AgoraGroup *) applyJoinPublicGroup: (NSString *)  aGroupId message: (NSString *)  aMessage error: (AgoraError **)  pError

required

Request to join a public group, group style should be AgoraGroupStylePublicJoinNeedApproval

Synchronization method will block the current thread

Parameters

aGroupId	Public group id
aMessage	Request info
pError	Error

Returns

Group instance

- (void) approveJoinGroupRequest: (NSString *)  aGroupId sender: (NSString *)  aUsername completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Approve a group request, owner‘s authority is required

Parameters

aGroupId	Group id
aUsername	Group request sender
aCompletionBlock	The callback block of completion

- (void) asyncAcceptInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -acceptInvitationFromGroup:inviter:completion: instead")  __deprecated_msg

required

Accept group's invitation

Parameters

groupId	Group id
aUsername	Inviter
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncAcceptJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername success: (void(^)())  aSuccessBlock failure: ("Use -approveJoinGroupRequest:sender:completion: instead")  __deprecated_msg

required

Accept user's application, need owner‘s authority

Parameters

aGroupId	Group id
aUsername	The applicant
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncAddOccupants: (NSArray *)  aOccupants toGroup: (NSString *)  aGroupId welcomeMessage: (NSString *)  aWelcomeMessage success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -addMembers:toGroup:message:completion: instead")  __deprecated_msg

required

Invite User to join a group

Parameters

aOccupants	Invited users
aGroupId	Group id
aWelcomeMessage	Welcome message
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncApplyJoinPublicGroup: (NSString *)  aGroupId message: (NSString *)  aMessage success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -requestToJoinPublicGroup:message:completion: instead")  __deprecated_msg

required

Apply to join a public group, group style should be AgoraGroupStylePublicJoinNeedApproval

Parameters

aGroupId	Public group id
aMessage	Apply message
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncBlockGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -blockGroup:completion: instead")  __deprecated_msg

required

Block group’s message, server will blocks the messages of the group to user, owner can't block the group's message

Parameters

aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncBlockOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -blockMembers:fromGroup:completion: instead")  __deprecated_msg

required

Add users to group’s blacklist, need owner‘s authority

Parameters

aOccupants	Users to be added
aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncChangeDescription: (NSString *)  aDescription forGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -updateDescription:forGroup:completion: instead")  __deprecated_msg

required

Change group’s description, need owner‘s authority

Parameters

aDescription	New group‘s description
aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncChangeGroupSubject: (NSString *)  aSubject forGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -updateGroupSubject:forGroup:completion: instead")  __deprecated_msg

required

Change group’s subject, need owner‘s authority

Parameters

aSubject	New group‘s subject
aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncCreateGroupWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage setting: (AgoraGroupOptions *)  aSetting success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -createGroupWithSubject:description:invitees:message:setting:completion instead")  __deprecated_msg

required

Create a group

Parameters

aSubject	Group subject
aDescription	Group description
aInvitees	Group members, without creater
aMessage	Invitation message
aSetting	Group options
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncDeclineInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername reason: (NSString *)  aReason success: (void(^)())  aSuccessBlock failure: ("Use -declineGroupInvitation:inviter:reason:completion: instead")  __deprecated_msg

required

Decline a group invitation

Parameters

aGroupId	Group id
aUsername	Inviter
aReason	Decline reason
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncDeclineJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername reason: (NSString *)  aReason success: (void(^)())  aSuccessBlock failure: ("Use -declineJoinGroupRequest:sender:reason:completion: instead")  __deprecated_msg

required

Decline user's application, need owner‘s authority

Parameters

aGroupId	Group id
aUsername	The applicant
aReason	Decline reason
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncDestroyGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -destroyGroup:completion: instead")  __deprecated_msg

required

Destroy a group, need owner‘s authority

Parameters

aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncFetchGroupBansList: (NSString *)  aGroupId success: (void(^)(NSArray *aList))  aSuccessBlock failure: ("Use -getGroupBlackListFromServerByID:completion: instead")  __deprecated_msg

required

Get group‘s blacklist, need owner’s authority

Parameters

aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncFetchGroupInfo: (NSString *)  aGroupId includeMembersList: (BOOL)  aIncludeMembersList success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -getGroupSpecificationFromServerByID:includeMembersList:completion: instead")  __deprecated_msg

required

Fetch group detail

Parameters

aGroupId	Group id
aIncludeMembersList	Whether get member list
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncGetMyGroupsFromServer: (void(^)(NSArray *aList))  aSuccessBlock failure: ("Use -getJoinedGroupsFromServerWithCompletion:")  __deprecated_msg

required

Get all of user's groups from server, will update group list in memory and DB after success

Parameters

aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncGetPublicGroupsFromServerWithCursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize success: (void(^)(AgoraCursorResult *aCursor))  aSuccessBlock failure: ("Use -getPublicGroupsFromServerWithCursor:pageSize:completion:")  __deprecated_msg

required

Get public groups in the specified range from the server

Parameters

aCursor	Get the cursor to join the group, call pass empty for the first time
aPageSize	Expect result count, will return all results if < 0
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncIgnoreGroupPush: (NSString *)  aGroupId ignore: (BOOL)  aIsIgnore success: (void(^)())  aSuccessBlock failure: ("Use -updatePushServiceForGroup:isPushEnabled:completion: instead")  __deprecated_msg

required

Block / unblock group message‘s push notification

Parameters

aGroupId	Group id
aIgnore	Whether block
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncJoinPublicGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -joinPublicGroup:completion: instead")  __deprecated_msg

required

Join a public group, group style should be AgoraGroupStylePublicOpenJoin

Parameters

aGroupId	Public group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncLeaveGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -leaveGroup:completion: instead")  __deprecated_msg

required

Leave a group, owner can't leave the group, can only destroy the group

Parameters

aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncRemoveOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -removeMembers:fromGroup:completion: instead")  __deprecated_msg

required

Remove members from group, need owner‘s authority

Parameters

aOccupants	Users to be removed
aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncSearchPublicGroupWithId: (NSString *)  aGroundId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -searchPublicGroupWithId:completion:")  __deprecated_msg

required

Search public group with the id

Parameters

aGroundId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncUnblockGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -unblockGroup:completion: instead")  __deprecated_msg

required

Unblock group message

Parameters

aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) asyncUnblockOccupants: (NSArray *)  aOccupants forGroup: (NSString *)  aGroupId success: (void(^)(AgoraGroup *aGroup))  aSuccessBlock failure: ("Use -unblockMembers:fromGroup:completion: instead")  __deprecated_msg

required

Remove users from group‘s blacklist, need owner‘s authority

Parameters

aOccupants	Users to be removed
aGroupId	Group id
aSuccessBlock	The callback block of success
aFailureBlock	The callback block of failure

- (void) blockGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Block group messages, server blocks the messages from the group, owner can't block the group's messages

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) blockGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Block group messages, server will blocks the messages from the group, owner can't block the group's message

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) blockMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Add users to group blacklist, owner‘s authority is required

Parameters

aMembers	Users to be added blackList
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) blockOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Add users to group blacklist, required owner‘s authority

Synchronization method will block the current thread

Parameters

aOccupants	Users to be added blackList
aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (AgoraGroup *) changeDescription: (NSString *)  aDescription forGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Change group description, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aDescription	New group description
aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (AgoraGroup *) changeGroupSubject: (NSString *)  aSubject forGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Change group subject, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aSubject	New group subject
aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) createGroupWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage setting: (AgoraGroupOptions *)  aSetting completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Create a group

Parameters

aSubject	Group subject
aDescription	Group description
aInvitees	Group members, without creater
aMessage	Invitation message
aSetting	Group options
aCompletionBlock	The callback block of completion

- (AgoraGroup *) createGroupWithSubject: (NSString *)  aSubject description: (NSString *)  aDescription invitees: (NSArray *)  aInvitees message: (NSString *)  aMessage setting: (AgoraGroupOptions *)  aSetting error: (AgoraError **)  pError

required

Create a group

Synchronization method will block the current thread

Parameters

aSubject	Group subject
aDescription	Group description
aInvitees	Group members, without creater
aMessage	Invitation message
aSetting	Group options
pError	Error

Returns

AgoraGroup Created group

- (void) declineGroupInvitation: (NSString *)  aGroupId inviter: (NSString *)  aInviter reason: (NSString *)  aReason completion: (void(^)(AgoraError *aError))  aCompletionBlock

required

Decline a group invitation

Parameters

aGroupId	Group id
aInviter	Inviter
aReason	Decline reason
aCompletionBlock	The callback block of completion

- (AgoraError *) declineInvitationFromGroup: (NSString *)  aGroupId inviter: (NSString *)  aUsername reason: (NSString *)  aReason

required

Decline a group invitation

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aUsername	Inviter
aReason	Decline reason

Returns

Error

- (AgoraError *) declineJoinApplication: (NSString *)  aGroupId applicant: (NSString *)  aUsername reason: (NSString *)  aReason

required

Decline a group request, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aUsername	Group request sender
aReason	Decline reason

Returns

Error

- (void) declineJoinGroupRequest: (NSString *)  aGroupId sender: (NSString *)  aUsername reason: (NSString *)  aReason completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Decline a group request, owner‘s authority is required

Parameters

aGroupId	Group id
aUsername	Group request sender
aReason	Decline reason
aCompletionBlock	The callback block of completion

- (AgoraError *) destroyGroup: (NSString *)  aGroupId

required

Destroy a group, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aGroupId

Group id

Returns

AgoraError Error, return nil if success

- (void) destroyGroup: (NSString *)  aGroupId completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager destroyGroup:finishCompletion:]

required

Destroy a group, owner‘s authority is required

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) destroyGroup: (NSString *)  aGroupId error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager destroyGroup:]

required

Destroy a group, owner‘s authority is required

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

Destroyed group, return nil if failed

- (void) destroyGroup: (NSString *)  aGroupId finishCompletion: (void(^)(AgoraError *aError))  aCompletionBlock

required

Destroy a group, owner‘s authority is required

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (void) downloadGroupSharedFileWithId: (NSString *)  aGroupId filePath: (NSString *)  aFilePath sharedFileId: (NSString *)  aSharedFileId progress: (void(^)(int progress))  aProgressBlock completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Download the share file of group

Parameters

aGroupId	Group id
aFilePath	Path of file
aSharedFileId	share file id
aProgressBlock	The block of attachment upload progress
aCompletionBlock	The callback block of completion

- (NSArray *) fetchGroupBansList: (NSString *)  aGroupId error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:error:]

required

Get group‘s blacklist, required owner’s authority

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

Group blacklist<NSString>

- (AgoraGroup *) fetchGroupInfo: (NSString *)  aGroupId includeMembersList: (BOOL)  aIncludeMembersList error: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getGroupSpecificationFromServerWithId:error:]

required

Fetch group info

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aIncludeMembersList	Whether to get member list，When YES, returns 200 members
pError	Error

Returns

Group instance

- (void) getGroupAnnouncementWithId: (NSString *)  aGroupId completion: (void(^)(NSString *aAnnouncement, AgoraError *aError))  aCompletionBlock

required

Get the announcement of group from the server

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (NSString *) getGroupAnnouncementWithId: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Get the announcement of group from the server

Parameters

aGroupId	Group id
pError	error

Returns

Group Announcement, return nil if fail

- (void) getGroupBlackListFromServerByID: (NSString *)  aGroupId completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getGroupBlacklistFromServerWithId:pageNumber:pageSize:completion:]

required

Get group's blacklist, owner’s authority is required

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (void) getGroupBlacklistFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get group's blacklist, need owner / admin permissions

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (NSArray *) getGroupBlacklistFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the blacklist of group from the server, need owner / admin permissions

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
pError	Error

Returns

NSArray Group blackList

- (void) getGroupFileListWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get the share files of group from the server

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (NSArray *) getGroupFileListWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the share files of group from the server

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
pError	error

Returns

NSArray The share files of group

- (void) getGroupMemberListFromServerWithId: (NSString *)  aGroupId cursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize completion: (void(^)(AgoraCursorResult *aResult, AgoraError *aError))  aCompletionBlock

required

Get the list of group members from the server

Parameters

aGroupId	Group id
aCursor	Get the cursor to join the group, call pass empty for the first time
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (AgoraCursorResult *) getGroupMemberListFromServerWithId: (NSString *)  aGroupId cursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the list of group members from the server

Parameters

aGroupId	Group id
aCursor	Get the cursor to join the group, call pass empty for the first time
aPageSize	Page size
pError	Error

Returns

AgoraCursorResult List and cursor

- (void) getGroupMuteListFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get the mutes of group from the server

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
aCompletionBlock	The callback block of completion

- (NSArray *) getGroupMuteListFromServerWithId: (NSString *)  aGroupId pageNumber: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get the mutes of group from the server

Parameters

aGroupId	Group id
aPageNum	Page number
aPageSize	Page size
pError	Error

Returns

NSArray Group muteList

- (void) getGroupSpecificationFromServerByID: (NSString *)  aGroupID includeMembersList: (BOOL)  aIncludeMembersList completion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getGroupSpecificationFromServerWithId:completion:]

required

Fetch group specification

Parameters

aGroupId	Group id
aIncludeMembersList	Whether to get member list，When YES, returns 200 members
aCompletionBlock	The callback block of completion

- (void) getGroupSpecificationFromServerWithId: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Fetch group specification, including: ID, name, description, setting, owner, admins

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) getGroupSpecificationFromServerWithId: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Fetch group info，include ID, name, description，setting, owner, admins

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) getGroupSpecificationFromServerWithId: (NSString *)  aGroupId fetchMembers: (BOOL)  fetchMembers completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Fetch group specification, including: ID, name, description, setting, owner, admins

Parameters

aGroupId	Group id
fetchMembers	FetchMembers whether need fetch group members, default action fetch 200 members
aCompletionBlock	The callback block of completion

- (AgoraGroup *) getGroupSpecificationFromServerWithId: (NSString *)  aGroupId fetchMembers: (BOOL)  fetchMembers error: (AgoraError **)  pError

required

Fetch group info，include ID, name, description，setting, owner, admins

Synchronization method will block the current thread

Parameters

aGroupId	Group id
fetchMembers	Whether need fetch group members, default action fetch 200 members
pError	Error

Returns

AgoraGroup Group instance

- (NSArray *) getGroupsWithoutPushNotification: (AgoraError **)  pError

required

Get the list of groups which have disabled Apple Push Notification Service

Parameters

pError

Error

Returns

NSArray groupId list

- (void) getGroupWhiteListFromServerWithId: (NSString *)  aGroupId completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get the whitelist of group from the server

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (NSArray *) getGroupWhiteListFromServerWithId: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Get the whitelist of group from the server

Parameters

aGroupId	Group id
pError	Error

Returns

NSArray Group whiteList

- (NSArray *) getJoinedGroups

required

Get all groups

Returns

NSArray Group list<AgoraGroup>

- (void) getJoinedGroupsFromServerWithCompletion: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getJoinedGroupsFromServerWithPage:pageSize:completion:]

required

Get all of user's groups from server

Parameters

aCompletionBlock

The callback block of completion

- (void) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize completion: (void(^)(NSArray *aList, AgoraError *aError))  aCompletionBlock

required

Get pagesize number group you joined from the server.

Parameters

aPageNum	Get the cursor to join the group, call pass empty for the first time
aPageSize	The number of results expected to be returned, if <0 then all results will be returned at once
aCompletionBlock	The callback block of completion

- (NSArray *) getJoinedGroupsFromServerWithPage: (NSInteger)  aPageNum pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get pagesize number group you joined from the server.

Synchronization method will block the current thread

Parameters

aPageNum	Get the cursor to join the group, call pass empty for the first time
aPageSize	The number of results expected to be returned, if <0 then all results will be returned at once
pError	Error

Returns

NSArray Group list<AgoraGroup>

- (NSArray *) getMyGroupsFromServerWithError: (3_1_0)  (3_3_0)  ("Use -")  EM_DEPRECATED_IOS[IAgoraGroupManager getJoinedGroupsFromServerWithPage:pageSize:error:]

required

Get all of user's groups from server

Synchronization method will block the current thread

Parameters

pError

Error

Returns

Group list<AgoraGroup>

- (void) getPublicGroupsFromServerWithCursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize completion: (void(^)(AgoraCursorResult *aResult, AgoraError *aError))  aCompletionBlock

required

Get public groups with the specified range from the server

Parameters

aCursor	Get the cursor to join the group, call pass empty for the first time
aPageSize	The number of results expected to be returned, if <0 then all results will be returned at once
aCompletionBlock	The callback block of completion

- (AgoraCursorResult *) getPublicGroupsFromServerWithCursor: (NSString *)  aCursor pageSize: (NSInteger)  aPageSize error: (AgoraError **)  pError

required

Get public groups with the specified range from the server

Synchronization method will block the current thread

Parameters

aCursor	Get the cursor to join the group, call pass empty for the first time
aPageSize	The number of results expected to be returned, if <0 then all results will be returned at once
pError	Error

Returns

AgoraCursorResult The result

- (AgoraError *) ignoreGroupPush: (NSString *)  aGroupId ignore: (BOOL)  aIsIgnore

required

Block/unblock group message‘s push notification

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aIsIgnore	Show/ignore push notificatino

Returns

Error

- (AgoraError *) ignoreGroupsPush: (NSArray *)  aGroupIDs ignore: (BOOL)  aIsIgnore

required

Block/unblock group message‘s push notification

Synchronization method will block the current thread

Parameters

aGroupIDs	Group ids list
aIsIgnore	Show or ignore push notification

Returns

Error

- (void) isMemberInWhiteListFromServerWithGroupId: (NSString *)  aGroupId completion: (void(^)(BOOL inWhiteList, AgoraError *aError))  aCompletionBlock

required

Gets whether the member is on the whitelist

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (BOOL) isMemberInWhiteListFromServerWithGroupId: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Gets whether the member is on the whitelist

Parameters

aGroupId	Group id
pError	Error

Returns

BOOL YES: in whiteList NO: not in whiteList

- (void) joinPublicGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Join a public group, group style should be AgoraGroupStylePublicOpenJoin

Parameters

aGroupId	Public group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) joinPublicGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Join a public group, group style should be AgoraGroupStylePublicOpenJoin

Synchronization method will block the current thread

Parameters

aGroupId	Public group id
pError	Error

Returns

Joined public group

- (void) leaveGroup: (NSString *)  aGroupId completion: (void(^)(AgoraError *aError))  aCompletionBlock

required

Leave a group, owner can't leave the group, can only destroy the group

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (void) leaveGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Leave a group, owner can't leave the group, can only destroy the group

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

- (void) muteAllMembersFromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

mute all members, need Owner / Admin permissions

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) muteAllMembersFromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

mute all members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

Group instance

- (void) muteMembers: (NSArray *)  aMuteMembers muteMilliseconds: (NSInteger)  aMuteMilliseconds fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Mute group members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMuteMembers	The list of mute, type is <NSString>
aMuteMilliseconds	Muted time duration in millisecond
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) muteMembers: (NSArray *)  aMuteMembers muteMilliseconds: (NSInteger)  aMuteMilliseconds fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Mute group members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMuteMembers	The list of mute, type is <NSString>
aMuteMilliseconds	Muted time duration in millisecond
aGroupId	Group id
pError	Error

Returns

Group instance

- (void) removeAdmin: (NSString *)  aAdmin fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Remove group admin, need Owner permissions

Parameters

aAdmin	Admin
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) removeAdmin: (NSString *)  aAdmin fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Remove group admin, need Owner permissions

Synchronization method will block the current thread

Parameters

aAdmin	Admin
aGroupId	Group id
pError	Error

Returns

Group instance

- (void) removeDelegate: (id)  aDelegate

required

Remove delegate

Parameters

aDelegate

Delegate

- (void) removeGroupSharedFileWithId: (NSString *)  aGroupId sharedFileId: (NSString *)  aSharedFileId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Remove the share file of group

Parameters

aGroupId	Group id
aSharedFileId	share file Id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) removeGroupSharedFileWithId: (NSString *)  aGroupId sharedFileId: (NSString *)  aSharedFileId error: (AgoraError **)  pError

required

Remove the share file of group

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aSharedFileId	share file Id
pError	error

Returns

Group instance

- (void) removeMembers: (NSArray *)  aUsers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Remove members from a group, owner‘s authority is required

Parameters

aUsers	Users to be removed
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) removeOccupants: (NSArray *)  aOccupants fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Remove members from a group, required owner‘s authority

Synchronization method will block the current thread

Parameters

aOccupants	Users to be removed
aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) removeWhiteListMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

remove white list members, need Owner / Admin permissions

Parameters

aMembers	The remove list of whitelist, type is <NSString>
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) removeWhiteListMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

remove white list members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The remove list of whitelist, type is <NSString>
aGroupId	Group id
pError	Error

Returns

Group instance

- (void) requestToJoinPublicGroup: (NSString *)  aGroupId message: (NSString *)  aMessage completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Request to join a public group, group style should be AgoraGroupStylePublicJoinNeedApproval

Parameters

aGroupId	Public group id
aMessage	Apply info
aCompletionBlock	The callback block of completion

- (void) searchPublicGroupWithId: (NSString *)  aGroundId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Search public group with group id

Parameters

aGroundId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) searchPublicGroupWithId: (NSString *)  aGroundId error: (AgoraError **)  pError

required

Search a public group with the id

Synchronization method will block the current thread

Parameters

aGroundId	Group id
pError	Error

Returns

AgoraGroup Searched group

- (void) unblockGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Unblock group message

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) unblockGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Unblock group messages

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) unblockMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Remove users out of group blacklist, owner‘s authority is required

Parameters

aMembers	Users to be removed from blackList
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) unblockOccupants: (NSArray *)  aOccupants forGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Remove users from group blacklist, required owner‘s authority

Synchronization method will block the current thread

Parameters

aOccupants	Users to be removed from blackList
aGroupId	Group id
pError	Error

Returns

AgoraGroup Group instance

- (void) unmuteAllMembersFromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

unmute all members, need Owner / Admin permissions

Parameters

aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) unmuteAllMembersFromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

unmute all members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aGroupId	Group id
pError	Error

Returns

Group instance

- (void) unmuteMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Unmute group members, need Owner / Admin permissions

Parameters

aMembers	The list of unmute, type is <NSString>
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (AgoraGroup *) unmuteMembers: (NSArray *)  aMembers fromGroup: (NSString *)  aGroupId error: (AgoraError **)  pError

required

Unmute group members, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aMembers	The list of unmute, type is <NSString>
aGroupId	Group id
pError	Error

Returns

Group instance

- (void) updateDescription: (NSString *)  aDescription forGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Change the group description, owner‘s authority is required

Parameters

aDescription	New group‘s description
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (void) updateGroupAnnouncementWithId: (NSString *)  aGroupId announcement: (NSString *)  aAnnouncement completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Update the announcement of group, need Owner / Admin permissions

Parameters

aGroupId	Group id
aAnnouncement	announcement of group
aCompletionBlock	The callback block of completion

- (AgoraGroup *) updateGroupAnnouncementWithId: (NSString *)  aGroupId announcement: (NSString *)  aAnnouncement error: (AgoraError **)  pError

required

Update the announcement of group, need Owner / Admin permissions

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aAnnouncement	announcement of group
pError	error

Returns

Group instance

- (void) updateGroupExtWithId: (NSString *)  aGroupId ext: (NSString *)  aExt completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Update the extended of the group, need Owner

Parameters

aGroupId	Group id
aExt	Extended of the group
aCompletionBlock	The callback block of completion

- (AgoraGroup *) updateGroupExtWithId: (NSString *)  aGroupId ext: (NSString *)  aExt error: (AgoraError **)  pError

required

Update the extended of the group, need Owner

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aExt	Extended of the group
pError	error

Returns

Group instance

- (void) updateGroupOwner: (NSString *)  aGroupId newOwner: (NSString *)  aNewOwner completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Change group owner, need Owner permissions

Parameters

aGroupId	Group id
aNewOwner	New group owner
aCompletionBlock	The callback block of completion

- (AgoraGroup *) updateGroupOwner: (NSString *)  aGroupId newOwner: (NSString *)  aNewOwner error: (AgoraError **)  pError

required

Change group owner, need Owner permissions

Synchronization method will block the current thread

Parameters

aGroupId	Group id
aNewOwner	New group owner
pError	Error

Returns

AgoraGroup Group instance

- (void) updateGroupSubject: (NSString *)  aSubject forGroup: (NSString *)  aGroupId completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Change the group subject, owner‘s authority is required

Parameters

aSubject	New group‘s subject
aGroupId	Group id
aCompletionBlock	The callback block of completion

- (void) updatePushServiceForGroup: (NSString *)  aGroupId isPushEnabled: (BOOL)  aIsEnable completion: (void(^)(AgoraGroup *aGroup, AgoraError *aError))  aCompletionBlock

required

Block/unblock group message‘s push notification

Parameters

aGroupId	Group id
aIsEnable	Whether enable
aCompletionBlock	The callback block of completion

- (void) updatePushServiceForGroups: (NSArray *)  aGroupIDs isPushEnabled: (BOOL)  aIsEnable completion: (void(^)(NSArray *groups, AgoraError *aError))  aCompletionBlock

required

Block/unblock group message‘s push notification

Parameters

aGroupIDs	Group ids list
aIsEnable	Whether enable
aCompletionBlock	The callback block of completion

- (void) uploadGroupSharedFileWithId: (NSString *)  aGroupId filePath: (NSString *)  aFilePath progress: (void(^)(int progress))  aProgressBlock completion: (void(^)(AgoraGroupSharedFile *aSharedFile, AgoraError *aError))  aCompletionBlock

required

Upload the share file of group

Parameters

aGroupId	Group id
aFilePath	Path of file
pError	error

Returns

Group instance

---

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

• AgoraChat.framework/Headers/IAgoraGroupManager.h