15#import <Foundation/Foundation.h>
17#import "AgoraChatCommonDefs.h"
18#import "AgoraChatGroupManagerDelegate.h"
19#import "AgoraChatGroup.h"
20#import "AgoraChatGroupOptions.h"
21#import "AgoraChatCursorResult.h"
22#import "AgoraChatGroupSharedFile.h"
35#pragma mark - Delegate
51 delegateQueue:(dispatch_queue_t _Nullable )aQueue;
64- (void)removeDelegate:(
id _Nonnull)aDelegate;
67#pragma mark - Get Group
101#pragma mark - Get group from server
131- (NSArray<
AgoraChatGroup *> *_Nullable )getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum
132 pageSize:(NSInteger)aPageSize
159 pageSize:(NSInteger)aPageSize
183- (void)getPublicGroupsFromServerWithCursor:(NSString *_Nullable)aCursor
184 pageSize:(NSInteger)aPageSize
208- (
AgoraChatGroup * _Nullable)searchPublicGroupWithId:(NSString *_Nonnull)aGroundId
226- (void)searchPublicGroupWithId:(NSString *_Nonnull)aGroundId
260- (
AgoraChatGroup * _Nullable)createGroupWithSubject:(NSString *_Nullable)aSubject
261 description:(NSString *_Nullable)aDescription
262 invitees:(NSArray<NSString *> * _Nullable)aInvitees
263 message:(NSString *_Nullable)aMessage
294- (void)createGroupWithSubject:(NSString *_Nullable)aSubject
295 description:(NSString *_Nullable)aDescription
296 invitees:(NSArray<NSString *> * _Nullable)aInvitees
297 message:(NSString *_Nullable)aMessage
301#pragma mark - Fetch Info
324- (
AgoraChatGroup * _Nullable)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId
350- (
AgoraChatGroup * _Nullable)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId
351 fetchMembers:(BOOL)fetchMembers
373- (void)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId
395- (void)getGroupSpecificationFromServerWithId:(NSString *_Nonnull)aGroupId
396 fetchMembers:(BOOL)fetchMembers
431 cursor:(NSString *_Nullable)aCursor
432 pageSize:(NSInteger)aPageSize
458- (void)getGroupMemberListFromServerWithId:(NSString *_Nonnull)aGroupId
459 cursor:(NSString *_Nullable)aCursor
460 pageSize:(NSInteger)aPageSize
492- (NSArray<NSString *> * _Nullable)getGroupBlacklistFromServerWithId:(NSString *_Nonnull)aGroupId
493 pageNumber:(NSInteger)aPageNum
494 pageSize:(NSInteger)aPageSize
520- (void)getGroupBlacklistFromServerWithId:(NSString *_Nonnull)aGroupId
521 pageNumber:(NSInteger)aPageNum
522 pageSize:(NSInteger)aPageSize
523 completion:(
void (^_Nullable)(NSArray<NSString *> * _Nullable aList,
AgoraChatError *_Nullable aError))aCompletionBlock;
551- (NSArray<NSString *> * _Nullable)getGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId
552 pageNumber:(NSInteger)aPageNum
553 pageSize:(NSInteger)aPageSize
579- (void)getGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId
580 pageNumber:(NSInteger)aPageNum
581 pageSize:(NSInteger)aPageSize
582 completion:(
void (^_Nullable)(NSArray<NSString *> * _Nullable aList,
AgoraChatError *_Nullable aError))aCompletionBlock;
607- (void)fetchGroupMuteListFromServerWithId:(NSString *_Nonnull)aGroupId
608 pageNumber:(NSInteger)aPageNum
609 pageSize:(NSInteger)aPageSize
610 completion:(
void (^_Nullable)(NSDictionary<NSString *, NSNumber *> *_Nullable aDict,
AgoraChatError *_Nullable aError))aCompletionBlock;
634 pageNumber:(NSInteger)aPageNum
635 pageSize:(NSInteger)aPageSize
659- (void)getGroupFileListWithId:(NSString *_Nonnull)aGroupId
660 pageNumber:(NSInteger)aPageNum
661 pageSize:(NSInteger)aPageSize
684- (NSArray *)getGroupWhiteListFromServerWithId:(NSString *_Nonnull)aGroupId
703- (void)getGroupWhiteListFromServerWithId:(NSString *_Nonnull)aGroupId
704 completion:(
void (^_Nullable)(NSArray<NSString *> * _Nullable aList,
AgoraChatError *_Nullable aError))aCompletionBlock;
725- (BOOL)isMemberInWhiteListFromServerWithGroupId:(NSString *_Nonnull)aGroupId
743- (void)isMemberInWhiteListFromServerWithGroupId:(NSString *_Nonnull)aGroupId
744 completion:(
void (^_Nullable)(BOOL inWhiteList,
AgoraChatError *_Nullable aError))aCompletionBlock;
762- (NSString *_Nullable)getGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId
780- (void)getGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId
781 completion:(
void (^_Nullable)(NSString *aAnnouncement,
AgoraChatError *_Nullable aError))aCompletionBlock;
783#pragma mark - Edit Group
810- (
AgoraChatGroup * _Nullable)addOccupants:(NSArray<NSString *> * _Nonnull)aOccupants
811 toGroup:(NSString *_Nonnull)aGroupId
812 welcomeMessage:(NSString *_Nullable)aWelcomeMessage
834- (void)addMembers:(NSArray<NSString *> * _Nonnull)aUsers
835 toGroup:(NSString *_Nonnull)aGroupId
836 message:(NSString *_Nullable)aMessage
866- (
AgoraChatGroup * _Nullable)removeOccupants:(NSArray<NSString *> * _Nonnull)aOccupants
867 fromGroup:(NSString *_Nonnull)aGroupId
891- (void)removeMembers:(NSArray<NSString *> * _Nonnull)aUsers
892 fromGroup:(NSString *_Nonnull)aGroupId
922- (
AgoraChatGroup * _Nullable)blockOccupants:(NSArray<NSString *> * _Nonnull)aOccupants
923 fromGroup:(NSString *_Nonnull)aGroupId
947- (void)blockMembers:(NSArray<NSString *> * _Nonnull)aMembers
948 fromGroup:(NSString *_Nonnull)aGroupId
979- (
AgoraChatGroup * _Nullable)unblockOccupants:(NSArray<NSString *> * _Nonnull)aOccupants
980 forGroup:(NSString *_Nonnull)aGroupId
1004- (void)unblockMembers:(NSArray<NSString *> * _Nonnull)aMembers
1005 fromGroup:(NSString *_Nonnull)aGroupId
1035- (
AgoraChatGroup * _Nullable)changeGroupSubject:(NSString *_Nullable)aSubject
1036 forGroup:(NSString *_Nonnull)aGroupId
1060- (void)updateGroupSubject:(NSString *_Nullable)aSubject
1061 forGroup:(NSString *_Nonnull)aGroupId
1091- (
AgoraChatGroup * _Nullable)changeDescription:(NSString *_Nullable)aDescription
1092 forGroup:(NSString *_Nonnull)aGroupId
1116- (void)updateDescription:(NSString *_Nullable)aDescription
1117 forGroup:(NSString *_Nonnull)aGroupId
1139- (void)leaveGroup:(NSString *_Nonnull)aGroupId
1157- (void)leaveGroup:(NSString *_Nonnull)aGroupId
1158 completion:(
void (^_Nullable)(
AgoraChatError *_Nullable aError))aCompletionBlock;
1203- (void)destroyGroup:(NSString *_Nonnull)aGroupId
1204 finishCompletion:(
void (^_Nullable)(
AgoraChatError *_Nullable aError))aCompletionBlock;
1230- (
AgoraChatGroup * _Nullable)blockGroup:(NSString *_Nonnull)aGroupId
1249- (void)blockGroup:(NSString *_Nonnull)aGroupId
1273- (
AgoraChatGroup * _Nullable)unblockGroup:(NSString *_Nonnull)aGroupId
1290- (void)unblockGroup:(NSString *_Nonnull)aGroupId
1321- (
AgoraChatGroup * _Nullable)updateGroupOwner:(NSString *_Nonnull)aGroupId
1322 newOwner:(NSString *_Nonnull)aNewOwner
1346- (void)updateGroupOwner:(NSString *_Nonnull)aGroupId
1347 newOwner:(NSString *_Nonnull)aNewOwner
1376 toGroup:(NSString *_Nonnull)aGroupId
1404- (void)addAdmin:(NSString *_Nonnull)aAdmin
1405 toGroup:(NSString *_Nonnull)aGroupId
1435- (
AgoraChatGroup * _Nullable)removeAdmin:(NSString *_Nonnull)aAdmin
1436 fromGroup:(NSString *_Nonnull)aGroupId
1464- (void)removeAdmin:(NSString *_Nonnull)aAdmin
1465 fromGroup:(NSString *_Nonnull)aGroupId
1498- (
AgoraChatGroup * _Nullable)muteMembers:(NSArray<NSString *> * _Nonnull)aMuteMembers
1499 muteMilliseconds:(NSInteger)aMuteMilliseconds
1500 fromGroup:(NSString *_Nonnull)aGroupId
1529- (void)muteMembers:(NSArray<NSString *> * _Nonnull)aMuteMembers
1530 muteMilliseconds:(NSInteger)aMuteMilliseconds
1531 fromGroup:(NSString *_Nonnull)aGroupId
1561- (
AgoraChatGroup * _Nullable)unmuteMembers:(NSArray<NSString *> * _Nonnull)aMembers
1562 fromGroup:(NSString *_Nonnull)aGroupId
1589- (void)unmuteMembers:(NSArray<NSString *> * _Nonnull)aMembers
1590 fromGroup:(NSString *_Nonnull)aGroupId
1618- (
AgoraChatGroup * _Nullable)muteAllMembersFromGroup:(NSString *_Nonnull)aGroupId
1643- (void)muteAllMembersFromGroup:(NSString *_Nonnull)aGroupId
1672- (
AgoraChatGroup * _Nullable)unmuteAllMembersFromGroup:(NSString *_Nonnull)aGroupId
1698- (void)unmuteAllMembersFromGroup:(NSString *_Nonnull)aGroupId
1729- (
AgoraChatGroup * _Nullable)addWhiteListMembers:(NSArray<NSString *> * _Nonnull)aMembers
1730 fromGroup:(NSString *_Nonnull)aGroupId
1755- (void)addWhiteListMembers:(NSArray<NSString *> * _Nonnull)aMembers
1756 fromGroup:(NSString *_Nonnull)aGroupId
1787- (
AgoraChatGroup * _Nullable)removeWhiteListMembers:(NSArray<NSString *> * _Nonnull)aMembers
1788 fromGroup:(NSString *_Nonnull)aGroupId
1815- (void)removeWhiteListMembers:(NSArray<NSString *> * _Nonnull)aMembers
1816 fromGroup:(NSString *_Nonnull)aGroupId
1838- (void)uploadGroupSharedFileWithId:(NSString *_Nonnull)aGroupId
1839 filePath:(NSString* _Nonnull)aFilePath
1840 progress:(
void (^_Nullable)(
int progress))aProgressBlock
1862- (void)downloadGroupSharedFileWithId:(NSString *_Nonnull)aGroupId
1863 filePath:(NSString *_Nonnull)aFilePath
1864 sharedFileId:(NSString *_Nonnull)aSharedFileId
1865 progress:(
void (^_Nullable)(
int progress))aProgressBlock
1889- (
AgoraChatGroup * _Nullable)removeGroupSharedFileWithId:(NSString *_Nonnull)aGroupId
1890 sharedFileId:(NSString *_Nonnull)aSharedFileId
1908- (void)removeGroupSharedFileWithId:(NSString *_Nonnull)aGroupId
1909 sharedFileId:(NSString *_Nonnull)aSharedFileId
1937- (
AgoraChatGroup * _Nullable)updateGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId
1938 announcement:(NSString *_Nullable)aAnnouncement
1965- (void)updateGroupAnnouncementWithId:(NSString *_Nonnull)aGroupId
1966 announcement:(NSString *_Nullable)aAnnouncement
1994- (
AgoraChatGroup * _Nullable)updateGroupExtWithId:(NSString *_Nonnull)aGroupId
1995 ext:(NSString *_Nullable)aExt
2018- (void)updateGroupExtWithId:(NSString *_Nonnull)aGroupId
2019 ext:(NSString *_Nullable)aExt
2022#pragma mark - Edit Public Group
2045- (
AgoraChatGroup * _Nullable)joinPublicGroup:(NSString *_Nonnull)aGroupId
2062- (void)joinPublicGroup:(NSString *_Nonnull)aGroupId
2088- (
AgoraChatGroup * _Nullable)applyJoinPublicGroup:(NSString *_Nonnull)aGroupId
2089 message:(NSString *_Nullable)aMessage
2109- (void)requestToJoinPublicGroup:(NSString *_Nonnull)aGroupId
2110 message:(NSString *_Nullable)aMessage
2113#pragma mark - Application
2140- (
AgoraChatError *)acceptJoinApplication:(NSString *_Nonnull)aGroupId
2141 applicant:(NSString *_Nonnull)aUsername;
2168- (void)approveJoinGroupRequest:(NSString *_Nonnull)aGroupId
2169 sender:(NSString *_Nonnull)aUsername
2199- (
AgoraChatError *)declineJoinApplication:(NSString *_Nonnull)aGroupId
2200 applicant:(NSString *_Nonnull)aUsername
2201 reason:(NSString *_Nullable)aReason;
2230- (void)declineJoinGroupRequest:(NSString *_Nonnull)aGroupId
2231 sender:(NSString *_Nonnull)aUsername
2232 reason:(NSString *_Nullable)aReason
2258- (
AgoraChatGroup * _Nullable)acceptInvitationFromGroup:(NSString *_Nonnull)aGroupId
2259 inviter:(NSString *_Nonnull)aUsername
2284- (void)acceptInvitationFromGroup:(NSString *_Nonnull)aGroupId
2285 inviter:(NSString *_Nonnull)aUsername
2311- (
AgoraChatError *)declineInvitationFromGroup:(NSString *_Nonnull)aGroupId
2312 inviter:(NSString *_Nonnull)aUsername
2313 reason:(NSString *_Nullable)aReason;
2338- (void)declineGroupInvitation:(NSString *_Nonnull)aGroupId
2339 inviter:(NSString *_Nonnull)aInviter
2340 reason:(NSString *_Nullable)aReason
2341 completion:(
void (^_Nullable)(
AgoraChatError *_Nullable aError))aCompletionBlock;
2371 ignore:(BOOL)aIsIgnore EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -
IAgoraChatPushManager::updatePushServiceForGroups:disablePush:");
2395- (void)updatePushServiceForGroup:(NSString *)aGroupId
2396 isPushEnabled:(BOOL)aIsEnable
2426 ignore:(BOOL)aIsIgnore EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -
IAgoraChatPushManager::updatePushServiceForGroups:disablePush:");
2449- (void)updatePushServiceForGroups:(NSArray *)aGroupIDs
2450 isPushEnabled:(BOOL)aIsEnable
2451 completion:(
void (^)(NSArray *groups,
AgoraChatError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_3_2, 3_8_3, "Use -
IAgoraChatPushManager::updatePushServiceForGroups:disablePush:completion:");
2453#pragma mark - EM_DEPRECATED_IOS 3.8.8
2481- (void)getJoinedGroupsFromServerWithPage:(NSInteger)aPageNum
2482 pageSize:(NSInteger)aPageSize
2484 __deprecated_msg("Use -getJoinedGroupsFromServerWithPage:pageSize:needAffiliations:needRole:error:completion: instead");
Definition: AgoraChatCursorResult.h:27
Definition: AgoraChatError.h:27
Definition: AgoraChatGroup.h:43
Definition: AgoraChatGroupOptions.h:42
Definition: AgoraChatGroupSharedFile.h:17
Definition: AgoraChatGroupManagerDelegate.h:40
Definition: IAgoraChatGroupManager.h:31
NSArray< AgoraChatGroup * > *_Nullable getJoinedGroups()
Definition: IAgoraChatPushManager.h:31