HyphenateChatSDK 4.11.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 "IEMPresenceManager.h"
24#import "IEMStatisticsManager.h"
25
26#import "EMDeviceConfig.h"
27#import "EMLocalNotificationManager.h"
28#import "EMLogDelegate.h"
29
43typedef NS_ENUM(NSInteger, EMServerCheckType) {
44 EMServerCheckAccountValidation = 0,
45 EMServerCheckGetDNSListFromServer,
46 EMServerCheckGetTokenFromServer,
47 EMServerCheckDoLogin,
48 EMServerCheckDoLogout,
49};
50
61@interface EMClient : NSObject
62{
63 EMPushOptions *_pushOptions;
64}
65
73@property(nonatomic, strong, readonly) NSString * _Nonnull version;
74
82@property(nonatomic, strong, readonly) NSString * _Nullable currentUsername;
83
91@property(nonatomic, strong, readonly) EMOptions * _Nonnull options;
92
100@property(nonatomic, strong, readonly) id<IEMChatManager> _Nullable chatManager;
101
109@property(nonatomic, strong, readonly) id<IEMContactManager> _Nullable contactManager;
110
118@property(nonatomic, strong, readonly) id<IEMGroupManager> _Nullable groupManager;
119
127@property (nonatomic, strong, readonly) id<IEMThreadManager> _Nullable threadManager;
128
136@property(nonatomic, strong, readonly) id<IEMChatroomManager> _Nullable roomManager;
137
145@property (nonatomic, strong, readonly) id<IEMPushManager> _Nullable pushManager;
146
165@property(nonatomic, readonly) BOOL isAutoLogin;
166
178@property(nonatomic, readonly) BOOL isLoggedIn;
179
190@property(nonatomic, readonly) BOOL isConnected;
191
203@property(nonatomic, readonly) NSString * _Nullable accessUserToken;
204
212@property(nonatomic, strong, readonly) id<IEMUserInfoManager> _Nullable userInfoManager;
213
221@property (nonatomic, strong, readonly) id<IEMPresenceManager> _Nullable presenceManager;
222
230@property (nonatomic, strong, readonly) id<IEMStatisticsManager> _Nullable statisticsManager;
231
232-(instancetype _Nonnull ) init __attribute__((unavailable("call sharedClient instead")));
233-(instancetype _Nonnull ) copy __attribute__((unavailable("call sharedClient instead")));
234-(instancetype _Nonnull ) mutableCopy __attribute__((unavailable("call sharedClient instead")));
242+ (instancetype _Nonnull )sharedClient;
243
244
252- (NSString *)version;
253
254#pragma mark - Delegate
255
268- (void)addDelegate:(id<EMClientDelegate>_Nonnull)aDelegate
269 delegateQueue:(dispatch_queue_t _Nullable )aQueue;
270
282- (void)removeDelegate:(id _Nonnull )aDelegate;
283
297- (void)addMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate
298 delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addMultiDevices(delegate:queue:));
299
311- (void)removeMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate;
312
313#pragma mark - Initialize SDK
314
330- (EMError *_Nullable)initializeSDKWithOptions:(EMOptions * _Nonnull )aOptions;
331
332#pragma mark - Change AppKey
333
355- (EMError *_Nullable)changeAppkey:(NSString * _Nonnull)aAppkey;
356
357#pragma mark - User Registration
386- (EMError *_Nullable)registerWithUsername:(NSString * _Nonnull)aUsername
387 password:(NSString * _Nonnull)aPassword;
388
413- (void)registerWithUsername:(NSString *_Nonnull)aUsername
414 password:(NSString *_Nonnull)aPassword
415 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError * _Nullable aError))aCompletionBlock;
416
417#pragma mark - Login
418
439- (void)fetchTokenWithUsername:(NSString *_Nonnull)aUsername
440 password:(NSString *_Nonnull)aPassword
441 completion:(void (^_Nullable)(NSString * _Nullable aToken, EMError * _Nullable aError))aCompletionBlock;
442
468- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
469 password:(NSString *_Nonnull)aPassword EM_DEPRECATED_IOS(3_0_0, 4_5_0,"Use -EMClient loginWithUsername:token:completion instead");
470
495- (void)loginWithUsername:(NSString *_Nonnull)aUsername
496 password:(NSString *_Nonnull)aPassword
497 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock EM_DEPRECATED_IOS(3_0_0, 4_5_0,"Use -EMClient loginWithUsername:token:completion instead");
498
524- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
525 token:(NSString *_Nonnull)aToken;
526
547- (void)loginWithUsername:(NSString *_Nonnull)aUsername
548 token:(NSString *_Nonnull)aToken
549 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock;
550
572- (EMError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
573 agoraToken:(NSString *_Nonnull)aAgoraToken EM_DEPRECATED_IOS(3_8_9, 4_2_0,"Use -EMClient loginWithUsername:token instead");
574
596- (void)loginWithUsername:(NSString *_Nonnull)aUsername
597 agoraToken:(NSString *_Nonnull)aAgoraToken
598 completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock EM_DEPRECATED_IOS(3_8_9, 4_2_0,"Use -EMClient loginWithUsername:token:completion instead");
599
623- (EMError *_Nullable)renewToken:(NSString *_Nonnull)newToken;
624
648- (void)renewToken:(NSString *_Nonnull)newToken completion:(void (^_Nullable)(EMError* _Nullable aError))aCompletionBlock;
649
650#pragma mark - Logout
651
676- (EMError *_Nullable)logout:(BOOL)aIsUnbindDeviceToken;
677
701- (void)logout:(BOOL)aIsUnbindDeviceToken
702 completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
703
704#pragma mark - PushKit
705
729- (EMError *_Nullable)bindPushKitToken:(NSData *_Nullable)aPushToken;
730
752- (void)registerPushKitToken:(NSData *_Nullable)aPushToken
753 completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
754
778- (EMError *_Nullable)unBindPushKitToken;
779
801- (void)unRegisterPushKitTokenWithCompletion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
802
803#pragma mark - APNs
804
829- (EMError *_Nullable)bindDeviceToken:(NSData *_Nonnull)aDeviceToken;
830
852- (void)registerForRemoteNotificationsWithDeviceToken:(NSData *_Nonnull)aDeviceToken
853 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
854
878- (void)registerForRemoteNotificationsWithCertName:(NSString *_Nonnull)aCertName
879 deviceToken:(NSData *_Nonnull)aDeviceToken
880 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
881
904- (void)bindFCMToken:(NSString* _Nonnull)aFCMToken
905 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
906
907#pragma mark - Log
908
926- (EMError *_Nullable)uploadLogToServer;
927
939- (void)uploadDebugLogToServerWithCompletion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
940
964- (NSString *_Nullable)getLogFilesPath:(EMError **_Nullable)pError;
965
985- (void)getLogFilesPathWithCompletion:(void (^_Nullable)(NSString *_Nullable aPath, EMError * _Nullable aError))aCompletionBlock;
986
1006- (void)log:(NSString *_Nonnull)aLog;
1007
1021- (void)addLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate
1022 delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addLog(delegate:queue:));
1023
1035- (void)removeLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate NS_SWIFT_NAME(removeLog(delegate:));
1036
1037#pragma mark - Multi Devices
1038
1062- (NSArray<EMDeviceConfig*> *_Nullable)getLoggedInDevicesFromServerWithUsername:(NSString * _Nonnull)aUsername
1063 password:(NSString * _Nonnull)aPassword
1064 error:(EMError ** _Nullable)pError;
1065
1086- (void)getLoggedInDevicesFromServerWithUsername:(NSString *_Nonnull)aUsername
1087 password:(NSString *_Nonnull)aPassword
1088 completion:(void (^_Nullable)(NSArray<EMDeviceConfig*> * _Nullable aList, EMError *_Nullable aError))aCompletionBlock;
1089
1110- (void)getLoggedInDevicesFromServerWithUserId:(NSString *_Nonnull)aUserID
1111 token:(NSString *_Nonnull)aToken
1112 completion:(void (^_Nullable)(NSArray<EMDeviceConfig*> * _Nullable aList, EMError *_Nullable aError))aCompletionBlock;
1113
1141- (EMError *_Nullable)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
1142 password:(NSString *_Nonnull)aPassword
1143 resource:(NSString *_Nonnull)aResource;
1144
1145
1171- (void)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
1172 password:(NSString *_Nonnull)aPassword
1173 resource:(NSString *_Nonnull)aResource
1174 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1175
1201- (void)kickDeviceWithUserId:(NSString *_Nonnull)aUserID
1202 token:(NSString *_Nonnull)aToken
1203 resource:(NSString *_Nonnull)aResource
1204 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1205
1225- (void)kickAllDevicesWithUserId:(NSString *_Nonnull)aUserID
1226 token:(NSString *_Nonnull)aToken
1227 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1228
1250- (EMError *_Nullable)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
1251 password:(NSString *_Nonnull)aPassword;
1252
1273- (void)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
1274 password:(NSString *_Nonnull)aPassword
1275 completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
1276
1288- (EMDeviceConfig *)getDeviceConfig:(EMError **)pError;
1289
1290#pragma mark - iOS
1291
1292
1306- (void)applicationDidEnterBackground:(id _Nonnull )aApplication;
1307
1321- (void)applicationWillEnterForeground:(id _Nonnull )aApplication;
1322
1338- (void)application:(id _Nonnull)application didReceiveRemoteNotification:(NSDictionary * _Nullable)userInfo;
1339
1340#pragma mark - Service Check
1341
1369- (void)serviceCheckWithUsername:(NSString *_Nonnull)aUsername
1370 password:(NSString *_Nonnull)aPassword
1371 completion:(void (^_Nullable)(EMServerCheckType aType, EMError *_Nullable aError))aCompletionBlock __deprecated_msg("This method is deprecated");
1372@end
Definition: EMClient.h:62
Definition: EMDeviceConfig.h:25
Definition: EMError.h:27
Definition: EMOptions.h:52
Definition: EMPushOptions.h:58
Definition: EMClientDelegate.h:47
Definition: EMLogDelegate.h:18
Definition: EMMultiDevicesDelegate.h:80