HyphenateChatSDK  3.8.7
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 
474 - (NSArray *)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
475  pageNumber:(NSInteger)aPageNum
476  pageSize:(NSInteger)aPageSize
477  error:(EMError **)pError;
478 
502 - (void)getChatroomMuteListFromServerWithId:(NSString *)aChatroomId
503  pageNumber:(NSInteger)aPageNum
504  pageSize:(NSInteger)aPageSize
505  completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
506 
507 
523 - (NSArray *)getChatroomWhiteListFromServerWithId:(NSString *)aChatroomId
524  error:(EMError **)pError;
525 
526 
542 - (void)getChatroomWhiteListFromServerWithId:(NSString *)aChatroomId
543  completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
544 
560 - (BOOL)isMemberInWhiteListFromServerWithChatroomId:(NSString *)aChatroomId
561  error:(EMError **)pError;
562 
578 - (void)isMemberInWhiteListFromServerWithChatroomId:(NSString *)aChatroomId
579  completion:(void (^)(BOOL inWhiteList, EMError *aError))aCompletionBlock;
597 - (NSString *)getChatroomAnnouncementWithId:(NSString *)aChatroomId
598  error:(EMError **)pError;
599 
615 - (void)getChatroomAnnouncementWithId:(NSString *)aChatroomId
616  completion:(void (^)(NSString *aAnnouncement, EMError *aError))aCompletionBlock;
617 
618 #pragma mark - Edit
619 
643 - (EMChatroom *)updateSubject:(NSString *)aSubject
644  forChatroom:(NSString *)aChatroomId
645  error:(EMError **)pError;
646 
664 - (void)updateSubject:(NSString *)aSubject
665  forChatroom:(NSString *)aChatroomId
666  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
667 
691 - (EMChatroom *)updateDescription:(NSString *)aDescription
692  forChatroom:(NSString *)aChatroomId
693  error:(EMError **)pError;
694 
712 - (void)updateDescription:(NSString *)aDescription
713  forChatroom:(NSString *)aChatroomId
714  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
715 
739 - (EMChatroom *)removeMembers:(NSArray *)aMembers
740  fromChatroom:(NSString *)aChatroomId
741  error:(EMError **)pError;
742 
760 - (void)removeMembers:(NSArray *)aMembers
761  fromChatroom:(NSString *)aChatroomId
762  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
763 
787 - (EMChatroom *)blockMembers:(NSArray *)aMembers
788  fromChatroom:(NSString *)aChatroomId
789  error:(EMError **)pError;
790 
808 - (void)blockMembers:(NSArray *)aMembers
809  fromChatroom:(NSString *)aChatroomId
810  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
811 
812 
836 - (EMChatroom *)unblockMembers:(NSArray *)aMembers
837  fromChatroom:(NSString *)aChatroomId
838  error:(EMError **)pError;
839 
857 - (void)unblockMembers:(NSArray *)aMembers
858  fromChatroom:(NSString *)aChatroomId
859  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
860 
884 - (EMChatroom *)updateChatroomOwner:(NSString *)aChatroomId
885  newOwner:(NSString *)aNewOwner
886  error:(EMError **)pError;
887 
905 - (void)updateChatroomOwner:(NSString *)aChatroomId
906  newOwner:(NSString *)aNewOwner
907  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
908 
932 - (EMChatroom *)addAdmin:(NSString *)aAdmin
933  toChatroom:(NSString *)aChatroomId
934  error:(EMError **)pError;
935 
953 - (void)addAdmin:(NSString *)aAdmin
954  toChatroom:(NSString *)aChatroomId
955  completion:(void (^)(EMChatroom *aChatroomp, EMError *aError))aCompletionBlock;
956 
980 - (EMChatroom *)removeAdmin:(NSString *)aAdmin
981  fromChatroom:(NSString *)aChatroomId
982  error:(EMError **)pError;
983 
1001 - (void)removeAdmin:(NSString *)aAdmin
1002  fromChatroom:(NSString *)aChatroomId
1003  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1004 
1005 
1031 - (EMChatroom *)muteMembers:(NSArray *)aMuteMembers
1032  muteMilliseconds:(NSInteger)aMuteMilliseconds
1033  fromChatroom:(NSString *)aChatroomId
1034  error:(EMError **)pError;
1035 
1056 - (void)muteMembers:(NSArray *)aMuteMembers
1057  muteMilliseconds:(NSInteger)aMuteMilliseconds
1058  fromChatroom:(NSString *)aChatroomId
1059  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1060 
1084 - (EMChatroom *)unmuteMembers:(NSArray *)aMembers
1085  fromChatroom:(NSString *)aChatroomId
1086  error:(EMError **)pError;
1087 
1106 - (void)unmuteMembers:(NSArray *)aMembers
1107  fromChatroom:(NSString *)aChatroomId
1108  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1109 
1110 
1111 
1133 - (EMChatroom *)muteAllMembersFromChatroom:(NSString *)aChatroomId
1134  error:(EMError **)pError;
1135 
1150 - (void)muteAllMembersFromChatroom:(NSString *)aChatroomId
1151  completion:(void(^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1152 
1153 
1175 - (EMChatroom *)unmuteAllMembersFromChatroom:(NSString *)aChatroomId
1176  error:(EMError **)pError;
1177 
1178 
1193 - (void)unmuteAllMembersFromChatroom:(NSString *)aChatroomId
1194  completion:(void(^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1195 
1196 
1220 - (EMChatroom *)addWhiteListMembers:(NSArray *)aMembers
1221  fromChatroom:(NSString *)aChatroomId
1222  error:(EMError **)pError;
1223 
1240 - (void)addWhiteListMembers:(NSArray *)aMembers
1241  fromChatroom:(NSString *)aChatroomId
1242  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1243 
1267 - (EMChatroom *)removeWhiteListMembers:(NSArray *)aMembers
1268  fromChatroom:(NSString *)aChatroomId
1269  error:(EMError **)pError;
1270 
1287 - (void)removeWhiteListMembers:(NSArray *)aMembers
1288  fromChatroom:(NSString *)aChatroomId
1289  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1290 
1312 - (EMChatroom *)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
1313  announcement:(NSString *)aAnnouncement
1314  error:(EMError **)pError;
1315 
1332 - (void)updateChatroomAnnouncementWithId:(NSString *)aChatroomId
1333  announcement:(NSString *)aAnnouncement
1334  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock;
1335 
1336 #pragma mark - EM_DEPRECATED_IOS 3.3.0
1337 
1361 - (EMChatroom *)fetchChatroomInfo:(NSString *)aChatroomId
1362  includeMembersList:(BOOL)aIncludeMembersList
1363  error:(EMError **)pError EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:error:] instead");
1364 
1381 - (void)getChatroomSpecificationFromServerByID:(NSString *)aChatroomId
1382  includeMembersList:(BOOL)aIncludeMembersList
1383  completion:(void (^)(EMChatroom *aChatroom, EMError *aError))aCompletionBlock EM_DEPRECATED_IOS(3_1_0, 3_3_0, "Use -[IEMChatroomManager getChatroomSpecificationFromServerWithId:completion:] instead");
1384 
1385 #pragma mark - EM_DEPRECATED_IOS 3.2.3
1386 
1398 - (void)addDelegate:(id<EMChatroomManagerDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMChatroomManager addDelegate:delegateQueue:] instead");
1399 
1400 #pragma mark - EM_DEPRECATED_IOS < 3.2.3
1401 
1421 - (NSArray *)getAllChatroomsFromServerWithError:(EMError **)pError __deprecated_msg("Use -getChatroomsFromServerWithPage instead");
1422 
1435 - (void)getAllChatroomsFromServerWithCompletion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock __deprecated_msg("Use -getChatroomsFromServerWithPage instead");
1436 
1451 - (void)asyncGetAllChatroomsFromServer:(void (^)(NSArray *aList))aSuccessBlock
1452  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getAllChatroomsFromServerWithCompletion: instead");
1453 
1471 - (void)asyncJoinChatroom:(NSString *)aChatroomId
1472  success:(void (^)(EMChatroom *aRoom))aSuccessBlock
1473  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -joinChatroom:completion: instead");
1474 
1494 - (void)asyncLeaveChatroom:(NSString *)aChatroomId
1495  success:(void (^)(EMChatroom *aRoom))aSuccessBlock
1496  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -leaveChatroom:completion: instead");
1497 
1516 - (void)asyncFetchChatroomInfo:(NSString *)aChatroomId
1517  includeMembersList:(BOOL)aIncludeMembersList
1518  success:(void (^)(EMChatroom *aChatroom))aSuccessBlock
1519  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getChatroomSpecificationFromServerByID:includeMembersList:completion: instead");
1520 @end
Definition: EMChatroom.h:42
Definition: EMCursorResult.h:25
Definition: EMError.h:27
Definition: EMPageResult.h:25
Definition: EMChatroomManagerDelegate.h:39
Definition: IEMChatroomManager.h:34