HyphenateChatSDK 4.1.0
EMClient.h
1
8#import <Foundation/Foundation.h>
9
10#import "EMClientDelegate.h"
11#import "EMError.h"
12#import "EMMultiDevicesDelegate.h"
13#import "EMOptions.h"
14#import "EMPushOptions.h"
15
16#import "IEMChatManager.h"
17#import "IEMChatroomManager.h"
18#import "IEMContactManager.h"
19#import "IEMGroupManager.h"
20#import "IEMThreadManager.h"
21#import "IEMPushManager.h"
22#import "IEMUserInfoManager.h"
23#import "IEMTranslateManager.h"
24#import "IEMPresenceManager.h"
25#import "IEMStatisticsManager.h"
26
27#import "EMDeviceConfig.h"
28#import "EMLocalNotificationManager.h"
29#import "EMTranslationResult.h"
30#import "EMLogDelegate.h"
31
45typedef NS_ENUM(NSInteger, EMServerCheckType) {
46 EMServerCheckAccountValidation = 0,
47 EMServerCheckGetDNSListFromServer,
48 EMServerCheckGetTokenFromServer,
49 EMServerCheckDoLogin,
50 EMServerCheckDoLogout,
51};
52
63@interface EMClient : NSObject
64{
65 EMPushOptions *_pushOptions;
66}
67
75@property(nonatomic, strong, readonly) NSString * _Nonnull version;
76
84@property(nonatomic, strong, readonly) NSString * _Nullable currentUsername;
85
93@property(nonatomic, strong, readonly) EMOptions * _Nonnull options;
94
102@property(nonatomic, strong, readonly) id<IEMChatManager> _Nullable chatManager;
103
111@property(nonatomic, strong, readonly) id<IEMContactManager> _Nullable contactManager;
112
120@property(nonatomic, strong, readonly) id<IEMGroupManager> _Nullable groupManager;
121
129@property (nonatomic, strong, readonly) id<IEMThreadManager> _Nullable threadManager;
130
138@property(nonatomic, strong, readonly) id<IEMChatroomManager> _Nullable roomManager;
139
147@property (nonatomic, strong, readonly) id<IEMPushManager> _Nullable pushManager;
148
167@property(nonatomic, readonly) BOOL isAutoLogin;
168
180@property(nonatomic, readonly) BOOL isLoggedIn;
181
192@property(nonatomic, readonly) BOOL isConnected;
193
205@property(nonatomic, readonly) NSString * _Nullable accessUserToken;
206
214@property(nonatomic, strong, readonly) id<IEMUserInfoManager> _Nullable userInfoManager;
215
223@property (nonatomic, strong, readonly) id<IEMPresenceManager> _Nullable presenceManager;
224
232@property (nonatomic, strong, readonly) id<IEMStatisticsManager> _Nullable statisticsManager;
233
241+ (instancetype _Nonnull )sharedClient;
242
243
251- (NSString *)version;
252
253#pragma mark - Delegate
254
267- (void)addDelegate:(id<EMClientDelegate>_Nonnull)aDelegate
268 delegateQueue:(dispatch_queue_t _Nullable )aQueue;
269
281- (void)removeDelegate:(id _Nonnull )aDelegate;
282
296- (void)addMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate
297 delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addMultiDevices(delegate:queue:));
298
310- (void)removeMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate;
311
312#pragma mark - Initialize SDK
313
329- (EMError *_Nullable)initializeSDKWithOptions:(EMOptions * _Nonnull )aOptions;
330
331#pragma mark - Change AppKey
332
354- (EMError *_Nullable)changeAppkey:(NSString * _Nonnull)aAppkey;
355
356#pragma mark - User Registration
385- (EMError *_Nullable)registerWithUsername:(NSString * _Nonnull)aUsername
386 password:(NSString * _Nonnull)aPassword;
387
412- (void)registerWithUsername:(NSString *_Nonnull)aUsername
413 password:(NSString *_Nonnull)aPassword
414 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError * _Nullable aError))aCompletionBlock;
415
416#pragma mark - Login
417
438- (void)fetchTokenWithUsername:(NSString *_Nonnull)aUsername
439 password:(NSString *_Nonnull)aPassword
440 completion:(void (^_Nullable)(NSString * _Nullable aToken, EMError * _Nullable aError))aCompletionBlock;
441
467- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
468 password:(NSString *_Nonnull)aPassword;
469
494- (void)loginWithUsername:(NSString *_Nonnull)aUsername
495 password:(NSString *_Nonnull)aPassword
496 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock;
497
523- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
524 token:(NSString *_Nonnull)aToken;
525
546- (void)loginWithUsername:(NSString *_Nonnull)aUsername
547 token:(NSString *_Nonnull)aToken
548 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock;
549
571- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
572 agoraToken:(NSString *_Nonnull)aAgoraToken;
573
595- (void)loginWithUsername:(NSString *_Nonnull)aUsername
596 agoraToken:(NSString *_Nonnull)aAgoraToken
597 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock;
598
622- (EMError *_Nullable)renewToken:(NSString *_Nonnull)newAgoraToken;
623
624#pragma mark - Logout
625
650- (EMError *_Nullable)logout:(BOOL)aIsUnbindDeviceToken;
651
675- (void)logout:(BOOL)aIsUnbindDeviceToken
676 completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
677
678#pragma mark - PushKit
679
703- (EMError *_Nullable)bindPushKitToken:(NSData *_Nullable)aPushToken;
704
726- (void)registerPushKitToken:(NSData *_Nullable)aPushToken
727 completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
728
752- (EMError *_Nullable)unBindPushKitToken;
753
775- (void)unRegisterPushKitTokenWithCompletion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
776
777#pragma mark - APNs
778
803- (EMError *_Nullable)bindDeviceToken:(NSData *_Nonnull)aDeviceToken;
804
826- (void)registerForRemoteNotificationsWithDeviceToken:(NSData *_Nonnull)aDeviceToken
827 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
828
851- (void)bindFCMToken:(NSString* _Nonnull)aFCMToken
852 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
853
854#pragma mark - Log
855
873- (EMError *_Nullable)uploadLogToServer;
874
886- (void)uploadDebugLogToServerWithCompletion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
887
911- (NSString *_Nullable)getLogFilesPath:(EMError **_Nullable)pError;
912
932- (void)getLogFilesPathWithCompletion:(void (^_Nullable)(NSString *_Nullable aPath, EMError * _Nullable aError))aCompletionBlock;
933
953- (void)log:(NSString *_Nonnull)aLog;
954
968- (void)addLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate
969 delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addLog(delegate:queue:));
970
982- (void)removeLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate NS_SWIFT_NAME(removeLog(delegate:));
983
984#pragma mark - Multi Devices
985
1009- (NSArray<EMDeviceConfig*> *_Nullable)getLoggedInDevicesFromServerWithUsername:(NSString * _Nonnull)aUsername
1010 password:(NSString * _Nonnull)aPassword
1011 error:(EMError ** _Nullable)pError;
1012
1033- (void)getLoggedInDevicesFromServerWithUsername:(NSString *_Nonnull)aUsername
1034 password:(NSString *_Nonnull)aPassword
1035 completion:(void (^_Nullable)(NSArray<EMDeviceConfig*> * _Nullable aList, EMError *_Nullable aError))aCompletionBlock;
1036
1057- (void)getLoggedInDevicesFromServerWithUserId:(NSString *_Nonnull)aUserID
1058 token:(NSString *_Nonnull)aToken
1059 completion:(void (^_Nullable)(NSArray<EMDeviceConfig*> * _Nullable aList, EMError *_Nullable aError))aCompletionBlock;
1060
1088- (EMError *_Nullable)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
1089 password:(NSString *_Nonnull)aPassword
1090 resource:(NSString *_Nonnull)aResource;
1091
1092
1118- (void)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
1119 password:(NSString *_Nonnull)aPassword
1120 resource:(NSString *_Nonnull)aResource
1121 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1122
1148- (void)kickDeviceWithUserId:(NSString *_Nonnull)aUserID
1149 token:(NSString *_Nonnull)aToken
1150 resource:(NSString *_Nonnull)aResource
1151 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1152
1172- (void)kickAllDevicesWithUserId:(NSString *_Nonnull)aUserID
1173 token:(NSString *_Nonnull)aToken
1174 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1175
1197- (EMError *_Nullable)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
1198 password:(NSString *_Nonnull)aPassword;
1199
1220- (void)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
1221 password:(NSString *_Nonnull)aPassword
1222 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1223
1235- (EMDeviceConfig *)getDeviceConfig:(EMError **)pError;
1236
1237#pragma mark - iOS
1238
1239
1253- (void)applicationDidEnterBackground:(id _Nonnull )aApplication;
1254
1268- (void)applicationWillEnterForeground:(id _Nonnull )aApplication;
1269
1285- (void)application:(id _Nonnull)application didReceiveRemoteNotification:(NSDictionary * _Nullable)userInfo;
1286
1287#pragma mark - Service Check
1288
1316- (void)serviceCheckWithUsername:(NSString *_Nonnull)aUsername
1317 password:(NSString *_Nonnull)aPassword
1318 completion:(void (^_Nullable)(EMServerCheckType aType, EMError *_Nullable aError))aCompletionBlock;
1319
1320@property (nonatomic, strong, readonly) id<IEMTranslateManager> _Nonnull translateManager EM_DEPRECATED_IOS(3_8_9, 3_9_5,"Use -IEMChatManager translateMessage: instead");
1321@end
Definition: EMClient.h:64
Definition: EMDeviceConfig.h:25
Definition: EMError.h:27
Definition: EMOptions.h:52
Definition: EMPushOptions.h:58
Definition: EMClientDelegate.h:46
Definition: EMLogDelegate.h:18
Definition: EMMultiDevicesDelegate.h:78