即时通讯 IM iOS API 参考

AgoraChatClient IAgoraChatManager AgoraChatMessage AgoraChatConversation IAgoraChatContactManager IAgoraChatGroupManager IAgoraChatroomManager IAgoraChatPresenceManager IAgoraChatThreadManager IAgoraChatPushManager IAgoraChatUserInfoManager
 
#import <Foundation/Foundation.h>
 
#import "AgoraChatClientDelegate.h"
#import "AgoraChatError.h"
#import "AgoraChatMultiDevicesDelegate.h"
#import "AgoraChatOptions.h"
#import "AgoraChatPushOptions.h"
 
#import "IAgoraChatManager.h"
#import "IAgoraChatroomManager.h"
#import "IAgoraChatContactManager.h"
#import "IAgoraChatGroupManager.h"
#import "IAgoraChatThreadManager.h"
#import "IAgoraChatPushManager.h"
#import "IAgoraChatUserInfoManager.h"
#import "IAgoraChatTranslateManager.h"
#import "IAgoraChatPresenceManager.h"
#import "IAgoraChatStatisticsManager.h"
 
#import "AgoraChatDeviceConfig.h"
#import "AgoraChatLocalNotificationManager.h"
#import "AgoraChatTranslationResult.h"
#import "AgoraChatLogDelegate.h"
 
typedef NS_ENUM(NSInteger, AgoraChatServerCheckType) {
  AgoraChatServerCheckAccountValidation = 0, 
  AgoraChatServerCheckGetDNSListFromServer,  
  AgoraChatServerCheckGetTokenFromServer,    
  AgoraChatServerCheckDoLogin,               
  AgoraChatServerCheckDoLogout,              
};
 
@interface AgoraChatClient : NSObject
{
  AgoraChatPushOptions *_pushOptions;
}
 
@property(nonatomic, strong, readonly) NSString * _Nonnull version;
 
@property(nonatomic, strong, readonly) NSString * _Nullable currentUsername;
 
@property(nonatomic, strong, readonly) AgoraChatOptions * _Nonnull options;
 
@property(nonatomic, strong, readonly) id<IAgoraChatManager> _Nullable chatManager;
 
@property(nonatomic, strong, readonly) id<IAgoraChatContactManager> _Nullable contactManager;
 
@property(nonatomic, strong, readonly) id<IAgoraChatGroupManager> _Nullable groupManager;
 
@property (nonatomic, strong, readonly) id<IAgoraChatThreadManager> _Nullable threadManager;
 
@property(nonatomic, strong, readonly) id<IAgoraChatroomManager> _Nullable roomManager;
 
@property (nonatomic, strong, readonly) id<IAgoraChatPushManager> _Nullable pushManager;
 
@property(nonatomic, readonly) BOOL isAutoLogin;
 
@property(nonatomic, readonly) BOOL isLoggedIn;
 
@property(nonatomic, readonly) BOOL isConnected;
 
@property(nonatomic, readonly) NSString * _Nullable accessUserToken;
 
@property(nonatomic, strong, readonly) id<IAgoraChatUserInfoManager> _Nullable userInfoManager;
 
@property (nonatomic, strong, readonly) id<IAgoraChatPresenceManager> _Nullable presenceManager;
 
@property (nonatomic, strong, readonly) id<IAgoraChatStatisticsManager> _Nullable statisticsManager;
 
+ (instancetype _Nonnull )sharedClient;
 
 
- (NSString *)version;
 
#pragma mark - Delegate
 
- (void)addDelegate:(id<AgoraChatClientDelegate>_Nonnull)aDelegate
      delegateQueue:(dispatch_queue_t _Nullable )aQueue;
 
- (void)removeDelegate:(id _Nonnull )aDelegate;
 
- (void)addMultiDevicesDelegate:(id<AgoraChatMultiDevicesDelegate>_Nonnull)aDelegate
                  delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addMultiDevices(delegate:queue:));
 
- (void)removeMultiDevicesDelegate:(id<AgoraChatMultiDevicesDelegate>_Nonnull)aDelegate;
 
#pragma mark - Initialize SDK
 
- (AgoraChatError *_Nullable)initializeSDKWithOptions:(AgoraChatOptions * _Nonnull )aOptions;
 
#pragma mark - Change AppKey
 
- (AgoraChatError *_Nullable)changeAppkey:(NSString * _Nonnull)aAppkey;
 
#pragma mark - User Registeration
 
- (AgoraChatError *_Nullable)registerWithUsername:(NSString * _Nonnull)aUsername
                                  password:(NSString * _Nonnull)aPassword;
 
- (void)registerWithUsername:(NSString *_Nonnull)aUsername
                    password:(NSString *_Nonnull)aPassword
                  completion:(void (^_Nullable)(NSString * _Nonnull aUsername, AgoraChatError * _Nullable aError))aCompletionBlock;
 
#pragma mark - Login
 
- (void)fetchTokenWithUsername:(NSString *_Nonnull)aUsername
                      password:(NSString *_Nonnull)aPassword
                    completion:(void (^_Nullable)(NSString * _Nullable aToken, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
                               password:(NSString *_Nonnull)aPassword;
 
- (void)loginWithUsername:(NSString *_Nonnull)aUsername
                 password:(NSString *_Nonnull)aPassword
               completion:(void (^_Nullable)(NSString * _Nonnull aUsername, AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
                                  token:(NSString *_Nonnull)aToken;
 
- (void)loginWithUsername:(NSString *_Nonnull)aUsername
                    token:(NSString *_Nonnull)aToken
               completion:(void (^_Nullable)(NSString * _Nonnull aUsername, AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)loginWithUsername:(NSString *_Nonnull)aUsername
                             agoraToken:(NSString *_Nonnull)aAgoraToken;
 
- (void)loginWithUsername:(NSString *_Nonnull)aUsername
               agoraToken:(NSString *_Nonnull)aAgoraToken
               completion:(void (^_Nullable)(NSString * _Nonnull aUsername, AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)renewToken:(NSString *_Nonnull)newAgoraToken;
 
#pragma mark - Logout
 
- (AgoraChatError *_Nullable)logout:(BOOL)aIsUnbindDeviceToken;
 
- (void)logout:(BOOL)aIsUnbindDeviceToken
    completion:(void (^_Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
 
#pragma mark - PushKit
 
- (AgoraChatError *_Nullable)bindPushKitToken:(NSData *_Nullable)aPushToken;
 
- (void)registerPushKitToken:(NSData *_Nullable)aPushToken
                  completion:(void (^_Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)unBindPushKitToken;
 
- (void)unRegisterPushKitTokenWithCompletion:(void (^_Nullable)(AgoraChatError * _Nullable aError))aCompletionBlock;
 
#pragma mark - APNs
 
- (AgoraChatError *_Nullable)bindDeviceToken:(NSData *_Nonnull)aDeviceToken;
 
- (void)registerForRemoteNotificationsWithDeviceToken:(NSData *_Nonnull)aDeviceToken
                                           completion:(void (^_Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
 
#pragma mark - Log
 
- (AgoraChatError *_Nullable)uploadLogToServer;
 
- (void)uploadDebugLogToServerWithCompletion:(void (^_Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (NSString *_Nullable)getLogFilesPath:(AgoraChatError **_Nullable)pError;
 
- (void)getLogFilesPathWithCompletion:(void (^_Nullable)(NSString *_Nullable aPath, AgoraChatError * _Nullable aError))aCompletionBlock;
 
- (void)log:(NSString *_Nonnull)aLog;
 
- (void)addLogDelegate:(id<AgoraChatLogDelegate>_Nonnull)aDelegate
         delegateQueue:(dispatch_queue_t _Nullable )aQueue NS_SWIFT_NAME(addLog(delegate:queue:));
 
- (void)removeLogDelegate:(id<AgoraChatLogDelegate>_Nonnull)aDelegate NS_SWIFT_NAME(removeLog(delegate:));
 
#pragma mark - Multi Devices
 
- (NSArray<AgoraChatDeviceConfig*> *_Nullable)getLoggedInDevicesFromServerWithUsername:(NSString * _Nonnull)aUsername
                                                                       password:(NSString * _Nonnull)aPassword
                                                                          error:(AgoraChatError ** _Nullable)pError;
 
- (void)getLoggedInDevicesFromServerWithUsername:(NSString *_Nonnull)aUsername
                                        password:(NSString *_Nonnull)aPassword
                                      completion:(void (^_Nullable)(NSArray<AgoraChatDeviceConfig*> * _Nullable aList, AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
                                    password:(NSString *_Nonnull)aPassword
                                    resource:(NSString *_Nonnull)aResource;
 
- (void)kickDeviceWithUsername:(NSString *_Nonnull)aUsername
                      password:(NSString *_Nonnull)aPassword
                      resource:(NSString *_Nonnull)aResource
                    completion:(void (^_Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatError *_Nullable)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
                                        password:(NSString *_Nonnull)aPassword;
 
- (void)kickAllDevicesWithUsername:(NSString *_Nonnull)aUsername
                          password:(NSString *_Nonnull)aPassword
                        completion:(void (^_Nullable)(AgoraChatError *_Nullable aError))aCompletionBlock;
 
- (AgoraChatDeviceConfig *)getDeviceConfig:(AgoraChatError **)pError;
 
#pragma mark - iOS
 
- (BOOL)migrateDatabaseToLatestSDK;
 
- (void)applicationDidEnterBackground:(id _Nonnull )aApplication;
 
- (void)applicationWillEnterForeground:(id _Nonnull )aApplication;
 
- (void)application:(id _Nonnull)application didReceiveRemoteNotification:(NSDictionary * _Nullable)userInfo;
 
#pragma mark - Service Check
 
- (void)serviceCheckWithUsername:(NSString *_Nonnull)aUsername
                        password:(NSString *_Nonnull)aPassword
                      completion:(void (^_Nullable)(AgoraChatServerCheckType aType, AgoraChatError *_Nullable aError))aCompletionBlock;
 
@property (nonatomic, strong, readonly) id<IAgoraChatTranslateManager> _Nonnull translateManager EM_DEPRECATED_IOS(3_8_9, 3_9_5,"Use -IAgoraChatManager translateMessage: instead");
@end