HyphenateSDK 3.6.3
EMClient.h
1 
8 #import <Foundation/Foundation.h>
9 
10 #import "EMClientDelegate.h"
11 #import "EMMultiDevicesDelegate.h"
12 #import "EMOptions.h"
13 #import "EMPushOptions.h"
14 #import "EMError.h"
15 
16 #import "IEMChatManager.h"
17 #import "IEMContactManager.h"
18 #import "IEMGroupManager.h"
19 #import "IEMChatroomManager.h"
20 
21 #import "EMDeviceConfig.h"
22 
30 typedef enum {
31  EMServerCheckAccountValidation = 0,
32  EMServerCheckGetDNSListFromServer,
33  EMServerCheckGetTokenFromServer,
34  EMServerCheckDoLogin,
35  EMServerCheckDoLogout,
36 } EMServerCheckType;
37 
41 @interface EMClient : NSObject
42 {
43  EMPushOptions *_pushOptions;
44 }
45 
53 @property (nonatomic, strong, readonly) NSString *version;
54 
62 @property (nonatomic, strong, readonly) NSString *currentUsername;
63 
71 @property (nonatomic, strong, readonly) EMOptions *options;
72 
80 @property (nonatomic, strong, readonly) EMPushOptions *pushOptions;
81 
89 @property (nonatomic, strong, readonly) id<IEMChatManager> chatManager;
90 
98 @property (nonatomic, strong, readonly) id<IEMContactManager> contactManager;
99 
107 @property (nonatomic, strong, readonly) id<IEMGroupManager> groupManager;
108 
116 @property (nonatomic, strong, readonly) id<IEMChatroomManager> roomManager;
117 
127 @property (nonatomic, readonly) BOOL isAutoLogin;
128 
136 @property (nonatomic, readonly) BOOL isLoggedIn;
137 
145 @property (nonatomic, readonly) BOOL isConnected;
146 
154 + (instancetype)sharedClient;
155 
156 
157 #pragma mark - Delegate
158 
172 - (void)addDelegate:(id<EMClientDelegate>)aDelegate
173  delegateQueue:(dispatch_queue_t)aQueue;
174 
186 - (void)removeDelegate:(id)aDelegate;
187 
201 - (void)addMultiDevicesDelegate:(id<EMMultiDevicesDelegate>)aDelegate
202  delegateQueue:(dispatch_queue_t)aQueue;
203 
215 - (void)removeMultiDevicesDelegate:(id<EMMultiDevicesDelegate>)aDelegate;
216 
217 #pragma mark - Initialize SDK
218 
234 - (EMError *)initializeSDKWithOptions:(EMOptions *)aOptions;
235 
236 
237 #pragma mark - Change AppKey
238 
254 - (EMError *)changeAppkey:(NSString *)aAppkey;
255 
256 
257 #pragma mark - User Registeration
258 
280 - (EMError *)registerWithUsername:(NSString *)aUsername
281  password:(NSString *)aPassword;
282 
303 - (void)registerWithUsername:(NSString *)aUsername
304  password:(NSString *)aPassword
305  completion:(void (^)(NSString *aUsername, EMError *aError))aCompletionBlock;
306 
307 
308 #pragma mark - Login
309 
326 - (void)fetchTokenWithUsername:(NSString *)aUsername
327  password:(NSString *)aPassword
328  completion:(void (^)(NSString *aToken, EMError *aError))aCompletionBlock;
329 
351 - (EMError *)loginWithUsername:(NSString *)aUsername
352  password:(NSString *)aPassword;
353 
370 - (void)loginWithUsername:(NSString *)aUsername
371  password:(NSString *)aPassword
372  completion:(void (^)(NSString *aUsername, EMError *aError))aCompletionBlock;
373 
395 - (EMError *)loginWithUsername:(NSString *)aUsername
396  token:(NSString *)aToken;
397 
414 - (void)loginWithUsername:(NSString *)aUsername
415  token:(NSString *)aToken
416  completion:(void (^)(NSString *aUsername, EMError *aError))aCompletionBlock;
417 
418 #pragma mark - Logout
419 
440 - (EMError *)logout:(BOOL)aIsUnbindDeviceToken;
441 
457 - (void)logout:(BOOL)aIsUnbindDeviceToken
458  completion:(void (^)(EMError *aError))aCompletionBlock;
459 
460 #pragma mark - APNs
461 
481 - (EMError *)bindDeviceToken:(NSData *)aDeviceToken;
482 
496 - (void)registerForRemoteNotificationsWithDeviceToken:(NSData *)aDeviceToken
497  completion:(void (^)(EMError *aError))aCompletionBlock;
498 
518 - (EMError *)setApnsNickname:(NSString *)aNickname;
519 
534 - (void)updatePushNotifiationDisplayName:(NSString *)aDisplayName
535  completion:(void (^)(NSString *aDisplayName, EMError *aError))aCompletionBlock;
536 
556 - (EMPushOptions *)getPushOptionsFromServerWithError:(EMError **)pError;
557 
569 - (void)getPushNotificationOptionsFromServerWithCompletion:(void (^)(EMPushOptions *aOptions, EMError *aError))aCompletionBlock;
570 
586 - (EMError *)updatePushOptionsToServer;
587 
599 - (void)updatePushNotificationOptionsToServerWithCompletion:(void (^)(EMError *aError))aCompletionBlock;
600 
601 #pragma mark - Log
602 
618 - (EMError *)uploadLogToServer;
619 
631 - (void)uploadDebugLogToServerWithCompletion:(void (^)(EMError *aError))aCompletionBlock;
632 
652 - (NSString *)getLogFilesPath:(EMError **)pError;
653 
665 - (void)getLogFilesPathWithCompletion:(void (^)(NSString *aPath, EMError *aError))aCompletionBlock;
666 
667 #pragma mark - Multi Devices
668 
692 - (NSArray *)getLoggedInDevicesFromServerWithUsername:(NSString *)aUsername
693  password:(NSString *)aPassword
694  error:(EMError **)pError;
695 
713 - (void)getLoggedInDevicesFromServerWithUsername:(NSString *)aUsername
714  password:(NSString *)aPassword
715  completion:(void (^)(NSArray *aList, EMError *aError))aCompletionBlock;
716 
742 - (EMError *)kickDeviceWithUsername:(NSString *)aUsername
743  password:(NSString *)aPassword
744  resource:(NSString *)aResource;
745 
746 
747 
767 - (void)kickDeviceWithUsername:(NSString *)aUsername
768  password:(NSString *)aPassword
769  resource:(NSString *)aResource
770  completion:(void (^)(EMError *aError))aCompletionBlock;
771 
793 - (EMError *)kickAllDevicesWithUsername:(NSString *)aUsername
794  password:(NSString *)aPassword;
795 
811 - (void)kickAllDevicesWithUsername:(NSString *)aUsername
812  password:(NSString *)aPassword
813  completion:(void (^)(EMError *aError))aCompletionBlock;
814 
815 #pragma mark - iOS
816 
834 - (BOOL)migrateDatabaseToLatestSDK;
835 
847 - (void)applicationDidEnterBackground:(id)aApplication;
848 
860 - (void)applicationWillEnterForeground:(id)aApplication;
861 
875 - (void)application:(id)application didReceiveRemoteNotification:(NSDictionary *)userInfo;
876 
877 #pragma mark - Service Check
878 
896 - (void)serviceCheckWithUsername:(NSString *)aUsername
897  password:(NSString *)aPassword
898  completion:(void (^)(EMServerCheckType aType, EMError *aError))aCompletionBlock;
899 
900 #pragma mark - EM_DEPRECATED_IOS 3.2.3
901 
913 - (void)addDelegate:(id<EMClientDelegate>)aDelegate EM_DEPRECATED_IOS(3_1_0, 3_2_2, "Use -[IEMCallManager addDelegate:delegateQueue:]");
914 
915 #pragma mark - EM_DEPRECATED_IOS < 3.2.3
916 
939 - (void)asyncRegisterWithUsername:(NSString *)aUsername
940  password:(NSString *)aPassword
941  success:(void (^)())aSuccessBlock
942  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -registerWithUsername:password:completion:");
943 
962 - (void)asyncLoginWithUsername:(NSString *)aUsername
963  password:(NSString *)aPassword
964  success:(void (^)())aSuccessBlock
965  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -loginWithUsername:password:completion");
966 
983 - (void)asyncLogout:(BOOL)aIsUnbindDeviceToken
984  success:(void (^)())aSuccessBlock
985  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -logout:completion:");
986 
1002 - (void)asyncBindDeviceToken:(NSData *)aDeviceToken
1003  success:(void (^)())aSuccessBlock
1004  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -registerForRemoteNotificationsWithDeviceToken:completion:");
1005 
1022 - (void)asyncSetApnsNickname:(NSString *)aNickname
1023  success:(void (^)())aSuccessBlock
1024  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -updatePushNotifiationDisplayName:copletion");
1025 
1039 - (void)asyncGetPushOptionsFromServer:(void (^)(EMPushOptions *aOptions))aSuccessBlock
1040  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -getPushOptionsFromServerWithCompletion:");
1041 
1056 - (void)asyncUpdatePushOptionsToServer:(void (^)())aSuccessBlock
1057  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -updatePushNotificationOptionsToServerWithCompletion:");
1058 
1072 - (void)asyncUploadLogToServer:(void (^)())aSuccessBlock
1073  failure:(void (^)(EMError *aError))aFailureBlock __deprecated_msg("Use -uploadDebugLogToServerWithCompletion:");
1074 
1094 - (BOOL)dataMigrationTo3 __deprecated_msg("Use -migrateDatabaseToLatestSDK");
1095 
1096 
1122 - (EMError *)kickDevice:(EMDeviceConfig *)aDevice
1123  username:(NSString *)aUsername
1124  password:(NSString *)aPassword __deprecated_msg("Use - kickDeviceWithUsername:password:resource:");
1125 
1126 
1146 - (void)kickDevice:(EMDeviceConfig *)aDevice
1147  username:(NSString *)aUsername
1148  password:(NSString *)aPassword
1149  completion:(void (^)(EMError *aError))aCompletionBlock __deprecated_msg("Use - kickDeviceWithUsername:password:resource:completion:");
1150 @end
EMOptions
Definition: EMOptions.h:39
EMMultiDevicesDelegate-p
Definition: EMMultiDevicesDelegate.h:56
IEMCallManager-p
Definition: IEMCallManager.h:32
EMClientDelegate-p
Definition: EMClientDelegate.h:38
EMError
Definition: EMError.h:26
EMClient
Definition: EMClient.h:41
EMDeviceConfig
Definition: EMDeviceConfig.h:17
EMPushOptions
Definition: EMPushOptions.h:69