HyphenateChatSDK  5.0.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 
25 #import "EMDeviceConfig.h"
26 #import "EMLocalNotificationManager.h"
27 #import "EMLogDelegate.h"
28 
39 @interface EMClient : NSObject
40 {
41  EMPushOptions *_pushOptions;
42 }
43 
51 @property(nonatomic, strong, readonly) NSString * _Nonnull version;
52 
60 @property(atomic, strong, readonly) NSString * _Nullable currentUsername;
61 
69 @property(nonatomic, strong, readonly) EMOptions * _Nonnull options;
70 
78 @property(nonatomic, strong, readonly) id<IEMChatManager> _Nullable chatManager;
79 
87 @property(nonatomic, strong, readonly) id<IEMContactManager> _Nullable contactManager;
88 
96 @property(nonatomic, strong, readonly) id<IEMGroupManager> _Nullable groupManager;
97 
105 @property (nonatomic, strong, readonly) id<IEMThreadManager> _Nullable threadManager;
106 
114 @property(nonatomic, strong, readonly) id<IEMChatroomManager> _Nullable roomManager;
115 
123 @property (nonatomic, strong, readonly) id<IEMPushManager> _Nullable pushManager;
124 
136 @property(nonatomic, readonly) BOOL isLoggedIn;
137 
148 @property(nonatomic, readonly) BOOL isConnected __deprecated_msg("Use -connectionState instead");
149 
157 @property (nonatomic, readonly) EMConnectionState connectionState;
158 
170 @property(nonatomic, readonly) NSString * _Nullable accessUserToken;
171 
179 @property(nonatomic, strong, readonly) id<IEMUserInfoManager> _Nullable userInfoManager;
180 
188 @property (nonatomic, strong, readonly) id<IEMPresenceManager> _Nullable presenceManager;
189 
190 -(instancetype _Nonnull ) init __attribute__((unavailable("call sharedClient instead")));
191 -(instancetype _Nonnull ) copy __attribute__((unavailable("call sharedClient instead")));
192 -(instancetype _Nonnull ) mutableCopy __attribute__((unavailable("call sharedClient instead")));
200 + (instancetype _Nonnull )sharedClient;
201 
202 
210 - (NSString *)version;
211 
212 #pragma mark - Delegate
213 
226 - (void)addDelegate:(id<EMClientDelegate>_Nonnull)aDelegate
227  delegateQueue:(dispatch_queue_t _Nullable )aQueue;
228 
240 - (void)removeDelegate:(id _Nonnull )aDelegate;
241 
255 - (void)addMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate
256  delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addMultiDevices(delegate:queue:));
257 
269 - (void)removeMultiDevicesDelegate:(id<EMMultiDevicesDelegate>_Nonnull)aDelegate;
270 
271 #pragma mark - Initialize SDK
272 
288 - (EMError *_Nullable)initializeSDKWithOptions:(EMOptions * _Nonnull )aOptions;
289 
290 #pragma mark - Change AppKey
291 
313 - (EMError *_Nullable)changeAppkey:(NSString * _Nonnull)aAppkey;
314 
336 - (EMError *_Nullable)changeAppId:(NSString * _Nonnull)aAppId;
337 
338 #pragma mark - Login
339 
360 - (void)loginWithUsername:(NSString *_Nonnull)aUsername
361  token:(NSString *_Nonnull)aToken
362  completion:(void (^_Nullable)(NSString * _Nonnull aUsername, EMError *_Nullable aError))aCompletionBlock;
363 
387 - (EMError *_Nullable)renewToken:(NSString *_Nonnull)newToken;
388 
412 - (void)renewToken:(NSString *_Nonnull)newToken completion:(void (^_Nullable)(EMError* _Nullable aError))aCompletionBlock;
413 
414 #pragma mark - Logout
415 
440 - (EMError *_Nullable)logout:(BOOL)aIsUnbindDeviceToken;
441 
465 - (void)logout:(BOOL)aIsUnbindDeviceToken
466  completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
467 
468 #pragma mark - PushKit
469 
493 - (EMError *_Nullable)bindPushKitToken:(NSData *_Nullable)aPushToken;
494 
516 - (void)registerPushKitToken:(NSData *_Nullable)aPushToken
517  completion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
518 
542 - (EMError *_Nullable)unBindPushKitToken;
543 
565 - (void)unRegisterPushKitTokenWithCompletion:(void (^_Nullable)(EMError * _Nullable aError))aCompletionBlock;
566 
567 #pragma mark - APNs
568 
593 - (EMError *_Nullable)bindDeviceToken:(NSData *_Nonnull)aDeviceToken;
594 
616 - (void)registerForRemoteNotificationsWithDeviceToken:(NSData *_Nonnull)aDeviceToken
617  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
618 
644 - (void)getRTCTokenWithChannel:(NSString* _Nullable)aChannelName
645  completion:(void (^_Nonnull)(NSUInteger rtcUId,NSString * _Nullable aToken,NSInteger expiredTs, EMError *_Nullable aError))aCompletionBlock;
646 
664 - (void)getUserIdByRTCUIds:(NSArray<NSNumber*>* _Nonnull)uIds completion:(void (^_Nullable)(NSDictionary<NSNumber*,NSString*> * _Nullable accountInfos, EMError *_Nullable aError))aCompletionBlock;
665 
689 - (void)registerForRemoteNotificationsWithCertName:(NSString *_Nonnull)aCertName
690  deviceToken:(NSData *_Nonnull)aDeviceToken
691  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
692 
715 - (void)bindFCMToken:(NSString* _Nonnull)aFCMToken
716  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
717 
718 #pragma mark - Log
719 
737 - (EMError *_Nullable)uploadLogToServer;
738 
750 - (void)uploadDebugLogToServerWithCompletion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
751 
775 - (NSString *_Nullable)getLogFilesPath:(EMError **_Nullable)pError;
776 
796 - (void)getLogFilesPathWithCompletion:(void (^_Nullable)(NSString *_Nullable aPath, EMError * _Nullable aError))aCompletionBlock;
797 
817 - (void)log:(NSString *_Nonnull)aLog;
818 
832 - (void)addLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate
833  delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addLog(delegate:queue:));
834 
846 - (void)removeLogDelegate:(id<EMLogDelegate>_Nonnull)aDelegate NS_SWIFT_NAME(removeLog(delegate:));
847 
848 #pragma mark - Multi Devices
849 
850 
851 
872 - (void)getLoggedInDevicesFromServerWithUserId:(NSString *_Nonnull)aUserID
873  token:(NSString *_Nonnull)aToken
874  completion:(void (^_Nullable)(NSArray<EMDeviceConfig*> * _Nullable aList, EMError *_Nullable aError))aCompletionBlock;
875 
876 
902 - (void)kickDeviceWithUserId:(NSString *_Nonnull)aUserID
903  token:(NSString *_Nonnull)aToken
904  resource:(NSString *_Nonnull)aResource
905  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
906 
926 - (void)kickAllDevicesWithUserId:(NSString *_Nonnull)aUserID
927  token:(NSString *_Nonnull)aToken
928  completion:(void (^_Nullable)(EMError *_Nullable aError))aCompletionBlock;
929 
941 - (EMDeviceConfig * _Nullable)getDeviceConfig:(EMError **)pError;
942 
943 #pragma mark - iOS
944 
945 
959 - (void)applicationDidEnterBackground:(id _Nonnull )aApplication;
960 
974 - (void)applicationWillEnterForeground:(id _Nonnull )aApplication;
975 
991 - (void)application:(id _Nonnull)application didReceiveRemoteNotification:(NSDictionary * _Nullable)userInfo;
992 
993 
994 @end
Definition: EMPushOptions.h:57
Definition: EMError.h:26
Definition: EMClientDelegate.h:51
Definition: EMMultiDevicesDelegate.h:82
Definition: EMLogDelegate.h:18
Definition: EMDeviceConfig.h:24
Definition: EMOptions.h:86
Definition: EMClient.h:39