HyphenateSDK  3.3.0
IEMChatroomManager.h
1 
15 #import <Foundation/Foundation.h>
16 
17 #import "EMCommonDefs.h"
18 #import "EMChatroomManagerDelegate.h"
19 #import "EMChatroomOptions.h"
20 #import "EMChatroom.h"
21 #import "EMPageResult.h"
22 
23 #import "EMCursorResult.h"
24 
25 @class EMError;
26 
34 @protocol IEMChatroomManager <NSObject>
35 
36 @required
37 
38 #pragma mark - Delegate
39 
53 - (void)addDelegate:(id<EMChatroomManagerDelegate>)aDelegate
54  delegateQueue:(dispatch_queue_t)aQueue;
55 
67 - (void)removeDelegate:(id<EMChatroomManagerDelegate>)aDelegate;
68 
69 #pragma mark - Fetch Chatrooms
70 
94 - (EMPageResult *)getChatroomsFromServerWithPage:(NSInteger)aPageNum
95  pageSize:(NSInteger)aPageSize
96  error:(EMError **)pError;
97 
115 - (void)getChatroomsFromServerWithPage:(NSInteger)aPageNum
116  pageSize:(NSInteger)aPageSize
117  completion:(void (^)(EMPageResult *aResult, EMError *aError))aCompletionBlock;
118 
119 #pragma mark - Create
120 
150 - (EMChatroom *)createChatroomWithSubject:(NSString *)aSubject
151  description:(NSString *)aDescription
152  invitees:(NSArray *)aInvitees
153  message:(NSString *)aMessage
154  maxMembersCount:(NSInteger)aMaxMembersCount
155  error:(EMError **)pError;
156 
180 - (void)createChatroomWithSubject:(NSString *)aSubject
181  description:(NSString *)aDescription
182  invitees:(NSArray *)aInvitees
183  message:(NSString *)aMessage
184  maxMembersCount:(NSInteger)aMaxMembersCount
185  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
186 
187 #pragma mark - Edit Chatroom
188 
210 - (EMChatroom *)joinChatroom:(NSString *)aChatroomId
211  error:(EMError **)pError;
212 
228 - (void)joinChatroom:(NSString *)aChatroomId
229  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
230 
250 - (void)leaveChatroom:(NSString *)aChatroomId
251  error:(EMError **)pError;
252 
268 - (void)leaveChatroom:(NSString *)aChatroomId
269  completion:(void (^)(EMError *aError))aCompletionBlock;
270 
290 - (EMError *)destroyChatroom:(NSString *)aChatroomId;
291 
306 - (void)destroyChatroom:(NSString *)aChatroomId
307  completion:(void (^)(EMError *aError))aCompletionBlock;
308 
309 #pragma mark - Fetch
310 
332 - (EMChatroom *)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
333  error:(EMError **)pError;
334 
349 - (void)getChatroomSpecificationFromServerWithId:(NSString *)aChatroomId
350  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
351 
374 - (EMCursorResult *)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
375  cursor:(NSString *)aCursor
376  pageSize:(NSInteger)aPageSize
377  error:(EMError **)pError;
378 
398 - (void)getChatroomMemberListFromServerWithId:(NSString *)aChatroomId
399  cursor:(NSString *)aCursor
400  pageSize:(NSInteger)aPageSize
401  completion:(void (^)(EMCursorResult *aResult, EMError *aError))aCompletionBlock;
402 
422 - (NSArray *)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
423  pageNumber:(NSInteger)aPageNum
424  pageSize:(NSInteger)aPageSize
425  error:(EMError **)pError;
426 
446 - (void)getChatroomBlacklistFromServerWithId:(NSString *)aChatroomId
447  pageNumber:(NSInteger)aPageNum
448  pageSize:(NSInteger)aPageSize
449  completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
450 
470 - (NSArray *)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
471  pageNumber:(NSInteger)aPageNum
472  pageSize:(NSInteger)aPageSize
473  error:(EMError **)pError;
474 
494 - (void)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
495  pageNumber:(NSInteger)aPageNum
496  pageSize:(NSInteger)aPageSize
497  completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
498 
499 #pragma mark - Edit
500 
524 - (EMChatroom *)updateSubject:(NSString *)aSubject
525  forChatroom:(NSString *)aChatroomId
526  error:(EMError **)pError;
527 
545 - (void)updateSubject:(NSString *)aSubject
546  forChatroom:(NSString *)aChatroomId
547  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
548 
572 - (EMChatroom *)updateDescription:(NSString *)aDescription
573  forChatroom:(NSString *)aChatroomId
574  error:(EMError **)pError;
575 
593 - (void)updateDescription:(NSString *)aDescription
594  forChatroom:(NSString *)aChatroomId
595  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
596 
620 - (EMChatroom *)removeMembers:(NSArray *)aMembers
621  fromChatroom:(NSString *)aChatroomId
622  error:(EMError **)pError;
623 
641 - (void)removeMembers:(NSArray *)aMembers
642  fromChatroom:(NSString *)aChatroomId
643  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
644 
668 - (EMChatroom *)blockMembers:(NSArray *)aMembers
669  fromChatroom:(NSString *)aChatroomId
670  error:(EMError **)pError;
671 
689 - (void)blockMembers:(NSArray *)aMembers
690  fromChatroom:(NSString *)aChatroomId
691  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
692 
693 
717 - (EMChatroom *)unblockMembers:(NSArray *)aMembers
718  fromChatroom:(NSString *)aChatroomId
719  error:(EMError **)pError;
720 
738 - (void)unblockMembers:(NSArray *)aMembers
739  fromChatroom:(NSString *)aChatroomId
740  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
741 
765 - (EMChatroom *)updateChatroomOwner:(NSString *)aChatroomId
766  newOwner:(NSString *)aNewOwner
767  error:(EMError **)pError;
768 
786 - (void)updateChatroomOwner:(NSString *)aChatroomId
787  newOwner:(NSString *)aNewOwner
788  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
789 
813 - (EMChatroom *)addAdmin:(NSString *)aAdmin
814  toChatroom:(NSString *)aChatroomId
815  error:(EMError **)pError;
816 
834 - (void)addAdmin:(NSString *)aAdmin
835  toChatroom:(NSString *)aChatroomId
836  completion:(void (^)(EMChatroom *aChatroomp, EMError *aError))aCompletionBlock;
837 
861 - (EMChatroom *)removeAdmin:(NSString *)aAdmin
862  fromChatroom:(NSString *)aChatroomId
863  error:(EMError **)pError;
864 
882 - (void)removeAdmin:(NSString *)aAdmin
883  fromChatroom:(NSString *)aChatroomId
884  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
885 
886 
912 - (EMChatroom *)muteMembers:(NSArray *)aMuteMembers
913  muteMilliseconds:(NSInteger)aMuteMilliseconds
914  fromChatroom:(NSString *)aChatroomId
915  error:(EMError **)pError;
916 
937 - (void)muteMembers:(NSArray *)aMuteMembers
938  muteMilliseconds:(NSInteger)aMuteMilliseconds
939  fromChatroom:(NSString *)aChatroomId
940  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
941 
965 - (EMChatroom *)unmuteMembers:(NSArray *)aMembers
966  fromChatroom:(NSString *)aChatroomId
967  error:(EMError **)pError;
968 
987 - (void)unmuteMembers:(NSArray *)aMembers
988  fromChatroom:(NSString *)aChatroomId
989  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
990 
991 #pragma mark - EM_DEPRECATED_IOS 3.3.0
992 
1016 - (EMChatroom *)fetchChatroomInfo:(NSString *)aChatroomId
1017  includeMembersList:(BOOL)aIncludeMembersList
1018  error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:error:]");
1019 
1036 - (void)getChatroomSpecificationFromServerByID:(NSString *)aChatroomId
1037  includeMembersList:(BOOL)aIncludeMembersList
1038  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:completion:]");
1039 
1040 #pragma mark - EM_DEPRECATED_IOS 3.2.3
1041 
1053 - (void)addDelegate:(id<EMChatroomManagerDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMChatroomManager addDelegate:delegateQueue:]");
1054 
1055 #pragma mark - EM_DEPRECATED_IOS < 3.2.3
1056 
1076 - (NSArray *)getAllChatroomsFromServerWithError:(EMError **)pError __deprecated_msg("Use -getChatroomsFromServerWithPage");
1077 
1090 - (void)getAllChatroomsFromServerWithCompletion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock __deprecated_msg("Use -getChatroomsFromServerWithPage");
1091 
1106 - (void)asyncGetAllChatroomsFromServer:(void (^)(NSArray *aList))aSuccessBlock
1107  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getAllChatroomsFromServerWithCompletion:");
1108 
1126 - (void)asyncJoinChatroom:(NSString *)aChatroomId
1127  success:(void (^)(EMChatroom *aRoom))aSuccessBlock
1128  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -joinChatroom:completion:");
1129 
1149 - (void)asyncLeaveChatroom:(NSString *)aChatroomId
1150  success:(void (^)(EMChatroom *aRoom))aSuccessBlock
1151  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -leaveChatroom:completion:");
1152 
1171 - (void)asyncFetchChatroomInfo:(NSString *)aChatroomId
1172  includeMembersList:(BOOL)aIncludeMembersList
1173  success:(void (^)(EMChatroom *aChatroom))aSuccessBlock
1174  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getChatroomSpecificationFromServerByID:includeMembersList:completion:");
1175 @end
Definition: EMChatroomManagerDelegate.h:38
Definition: EMError.h:26
Definition: EMPageResult.h:24
Definition: EMChatroom.h:41
Definition: EMCursorResult.h:24
Definition: IEMChatroomManager.h:34