AgoraChatSDK 1.0.7
Instance Methods | Class Methods | Protected Attributes | Properties | List of all members
AgoraChatClient Class Reference

#import <AgoraChatClient.h>

Inheritance diagram for AgoraChatClient:

Instance Methods

(NSString *) - version
 
(void) - addDelegate:delegateQueue:
 
(void) - removeDelegate:
 
(void) - addMultiDevicesDelegate:delegateQueue:
 
(void) - removeMultiDevicesDelegate:
 
(AgoraChatError *_Nullable) - initializeSDKWithOptions:
 
(AgoraChatError *_Nullable) - changeAppkey:
 
(AgoraChatError *_Nullable) - registerWithUsername:password:
 
(void) - registerWithUsername:password:completion:
 
(void) - fetchTokenWithUsername:password:completion:
 
(AgoraChatError *_Nullable) - loginWithUsername:password:
 
(void) - loginWithUsername:password:completion:
 
(AgoraChatError *_Nullable) - loginWithUsername:token:
 
(void) - loginWithUsername:token:completion:
 
(AgoraChatError *_Nullable) - loginWithUsername:agoraToken:
 
(void) - loginWithUsername:agoraToken:completion:
 
(AgoraChatError *_Nullable) - renewToken:
 
(AgoraChatError *_Nullable) - logout:
 
(void) - logout:completion:
 
(AgoraChatError *_Nullable) - bindPushKitToken:
 
(void) - registerPushKitToken:completion:
 
(AgoraChatError *_Nullable) - unBindPushKitToken
 
(void) - unRegisterPushKitTokenWithCompletion:
 
(AgoraChatError *_Nullable) - bindDeviceToken:
 
(void) - registerForRemoteNotificationsWithDeviceToken:completion:
 
(AgoraChatError *_Nullable) - uploadLogToServer
 
(void) - uploadDebugLogToServerWithCompletion:
 
(NSString *_Nullable) - getLogFilesPath:
 
(void) - getLogFilesPathWithCompletion:
 
(void) - log:
 
(void) - addLogDelegate:delegateQueue:
 
(void) - removeLogDelegate:
 
(NSArray< AgoraChatDeviceConfig * > *_Nullable) - getLoggedInDevicesFromServerWithUsername:password:error:
 
(void) - getLoggedInDevicesFromServerWithUsername:password:completion:
 
(AgoraChatError *_Nullable) - kickDeviceWithUsername:password:resource:
 
(void) - kickDeviceWithUsername:password:resource:completion:
 
(AgoraChatError *_Nullable) - kickAllDevicesWithUsername:password:
 
(void) - kickAllDevicesWithUsername:password:completion:
 
(BOOL) - migrateDatabaseToLatestSDK
 
(void) - applicationDidEnterBackground:
 
(void) - applicationWillEnterForeground:
 
(void) - application:didReceiveRemoteNotification:
 
(void) - serviceCheckWithUsername:password:completion:
 
(id< IAgoraChatTranslateManager > _Nonnull translateManager) - EM_DEPRECATED_IOS
 

Class Methods

(instancetype _Nonnull) + sharedClient
 

Protected Attributes

AgoraChatPushOptions_pushOptions
 

Properties

NSString *_Nonnull version
 
NSString *_Nullable currentUsername
 
AgoraChatOptions *_Nonnull options
 
id< IAgoraChatManager > _Nullable chatManager
 
id< IAgoraChatContactManager > _Nullable contactManager
 
id< IAgoraChatGroupManager > _Nullable groupManager
 
id< IAgoraChatThreadManager > _Nullable threadManager
 
id< IAgoraChatroomManager > _Nullable roomManager
 
id< IAgoraChatPushManager > _Nullable pushManager
 
BOOL isAutoLogin
 
BOOL isLoggedIn
 
BOOL isConnected
 
NSString *_Nullable accessUserToken
 
id< IAgoraChatUserInfoManager > _Nullable userInfoManager
 
id< IAgoraChatPresenceManager > _Nullable presenceManager
 

Detailed Description

The AgoraChatClient, which is the entry point of the Chat SDK. You can log in, log out, and access other functionalities such as group and chatroom with this class. [AgoraChatClient sharedClient].groupManager;

Method Documentation

◆ addDelegate:delegateQueue:

- (void) addDelegate: (id< AgoraChatClientDelegate >_Nonnull)  aDelegate
delegateQueue: (dispatch_queue_t _Nullable)  aQueue 

Add the AgoraChatClientDelegate, so when the delegate event occurs, the delegate will call the methods automatically in <AgoraChatClientDelegate>.

Parameters
aDelegateThe delegate that you want to add: ClientDelegate.
aQueue(optional) The queue of calling delegate methods. If you want to run the app on the main thread, set this parameter as nil.

◆ addLogDelegate:delegateQueue:

- (void) addLogDelegate: (id< AgoraChatLogDelegate >_Nonnull)  aDelegate
delegateQueue: (addLog(delegate:queue:))  NS_SWIFT_NAME 

Add the log callback delegate.

Parameters
aDelegateThe delegate that you want to add: AgoraChatLogDelegate.
aQueueThe queue of calling delegate methods.

◆ addMultiDevicesDelegate:delegateQueue:

- (void) addMultiDevicesDelegate: (id< AgoraChatMultiDevicesDelegate >_Nonnull)  aDelegate
delegateQueue: (addMultiDevices(delegate:queue:))  NS_SWIFT_NAME 

Add the multi-device delegate.

Parameters
aDelegateThe delegate that you want to add: MultiDevicesDelegate.
aQueueThe queue of calling delegate methods.

◆ application:didReceiveRemoteNotification:

- (void) application: (id _Nonnull)  application
didReceiveRemoteNotification: (NSDictionary *_Nullable)  userInfo 

Occurs when your app is running in the foreground and the device receives an Apple Push Notification (APN).

Parameters
applicationThe current application instance.
userInfoThe push content.

◆ applicationDidEnterBackground:

- (void) applicationDidEnterBackground: (id _Nonnull)  aApplication

Disconnects from the chat server when the app is switched to background.

Parameters
aApplicationUIApplication

◆ applicationWillEnterForeground:

- (void) applicationWillEnterForeground: (id _Nonnull)  aApplication

Reconnect to the server when your app returns to foreground mode.

Parameters
aApplicationThe current application instance.

◆ bindDeviceToken:

- (AgoraChatError *_Nullable) bindDeviceToken: (NSData *_Nonnull)  aDeviceToken

Device token binding is required to enable Apple Push Notification Service.

This is a synchronous method and blocks the current thread.

Parameters
aDeviceTokenDevice token to bind.

@Result Returns nil on success, and the description of the issue that cause the call to fail.

◆ bindPushKitToken:

- (AgoraChatError *_Nullable) bindPushKitToken: (NSData *_Nullable)  aPushToken

Use the pushkit token to bind the user and the device, which is required to enable Apple PushKit Service.

This is a synchronous method and blocks the current thread.

Parameters
aPushTokenThe pushkit token to bind.
Returns
A description of the issue that caused this call to fail.

◆ changeAppkey:

- (AgoraChatError *_Nullable) changeAppkey: (NSString *_Nonnull)  aAppkey

Update the unique identifier used to access server.

You retrieve the new app key from server. As this key controls all access to server for your app, you can only update the key when the current user is logged out.

Parameters
aAppkeyThe app key.

@Result A description of the issue that caused this call to fail.

◆ fetchTokenWithUsername:password:completion:

- (void) fetchTokenWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(NSString *_Nullable aToken, AgoraChatError *_Nullable aError))  aCompletionBlock 

Fetches the token from the server.

This is an asynchronous method.

Parameters
aUsernameThe username.
aPasswordThe password.
aCompletionBlockThe completion block, which contains the token and the error message if the method fails.

◆ getLogFilesPath:

- (NSString *_Nullable) getLogFilesPath: (AgoraChatError **_Nullable)  pError

Compress the debug log into a gzip archive. Best practice is to delete this debug archive as soon as it is no longer used.

This is a synchronous method and blocks the current thread.

Parameters
pErrorA description of the issue that caused this call to fail.
Returns
NSString The full filepath to the debug archive.

◆ getLogFilesPathWithCompletion:

- (void) getLogFilesPathWithCompletion: (void(^)(NSString *_Nullable aPath, AgoraChatError *_Nullable aError))  aCompletionBlock

Compresses the log files in the format of .gz and returns the path of the compressed file. Recommends deleting the compressed file when it is no longer used.

This is an asynchronous method.

Parameters
aCompletionBlockThe completion block, which contains the token and the error message if the method fails.

◆ getLoggedInDevicesFromServerWithUsername:password:completion:

- (void) getLoggedInDevicesFromServerWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(NSArray< AgoraChatDeviceConfig * > *_Nullable aList, AgoraChatError *_Nullable aError))  aCompletionBlock 

Get all the device information <AgoraChatDeviceConfig> that logged in to the server.

This is an asynchronous method.

Parameters
aUsernameThe username.
aPasswordThe password.
aCompletionBlockThe completion block, which contains the list and the error message if the method fails.

◆ getLoggedInDevicesFromServerWithUsername:password:error:

- (NSArray< AgoraChatDeviceConfig * > *_Nullable) getLoggedInDevicesFromServerWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
error: (AgoraChatError **_Nullable)  pError 

Retrieve the array of devices the user is currently logged into.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username.
aPasswordThe password.
pErrorA description of the issue that caused this call to fail.
Returns
The information of the logged in devices, an array of <AgoraChatDeviceConfig> objects.

◆ initializeSDKWithOptions:

- (AgoraChatError *_Nullable) initializeSDKWithOptions: (AgoraChatOptions *_Nonnull)  aOptions

Initialize the SDK.

Parameters
aOptionsThe SDK setting options: Options..

@Result AgoraChatError A description of the issue that caused this call to fail.

◆ kickAllDevicesWithUsername:password:

- (AgoraChatError *_Nullable) kickAllDevicesWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword 

Kicks a user from your app installed on all the devices.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username.
aPasswordThe password.
Returns
Returns nil on success, and the description of the issue that cause the call to fail.

◆ kickAllDevicesWithUsername:password:completion:

- (void) kickAllDevicesWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock 

Kicks a single user from your app installed on all the devices.

This is an asynchronous method.

Parameters
aUsernameThe username.
aPasswordThe password.
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ kickDeviceWithUsername:password:resource:

- (AgoraChatError *_Nullable) kickDeviceWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
resource: (NSString *_Nonnull)  aResource 

Kick a single user from your app installed on a specific device.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username.
aPasswordThe password.
aResourceThe device to log aUsername out from. Call getLoggedInDevicesFromServerWithUsername to retrieve the list of devices aUsername is currently logged into.
Returns
Returns nil on success, and the description of the issue that cause the call to fail.

◆ kickDeviceWithUsername:password:resource:completion:

- (void) kickDeviceWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
resource: (NSString *_Nonnull)  aResource
completion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock 

Kick a single user from your app installed on a specific device.

The device information can be obtained from getLoggedInDevicesFromServerWithUsername.

This is an asynchronous method.

Parameters
aUsernameThe username.
aPasswordThe password.
aResourceThe device to be logged out of. You can get the logged in devices through getLoggedInDevicesFromServerWithUsername.
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ log:

- (void) log: (NSString *_Nonnull)  aLog

Output log info to log file. You can call this method after the SDK has been initialized.

This is a synchronous method and blocks the current thread.

Parameters
aLogThe log info.

◆ loginWithUsername:agoraToken:

- (AgoraChatError *_Nullable) loginWithUsername: (NSString *_Nonnull)  aUsername
agoraToken: (NSString *_Nonnull)  aAgoraToken 

A user logs in to the chat server with Agora Chat user token. Supports automatic login.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username.
aAgoraTokenThe Agora Chat user token.
Returns
Returns nil on success, and the description of the issue that cause the call to fail.

◆ loginWithUsername:agoraToken:completion:

- (void) loginWithUsername: (NSString *_Nonnull)  aUsername
agoraToken: (NSString *_Nonnull)  aAgoraToken
completion: (void(^)(NSString *_Nonnull aUsername, AgoraChatError *_Nullable aError))  aCompletionBlock 

A user logs in to the chat server with Agora Chat user token. Supports automatic login.

Parameters
aUsernameThe username.
aAgoraTokenThe Agora Chat user token.
aCompletionBlockThe callback of completion block, which contains the description of the cause to the issue if the method fails.

◆ loginWithUsername:password:

- (AgoraChatError *_Nullable) loginWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword 

A user logs in to the chat server with a password.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aPasswordThe password. The maximum length is 64 characters. Ensure that you set this parameter.
Returns
Returns nil on success, and the description of the issue that cause the call to fail.

◆ loginWithUsername:password:completion:

- (void) loginWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(NSString *_Nonnull aUsername, AgoraChatError *_Nullable aError))  aCompletionBlock 

A user logs in to the chat server with a password.

This is an asynchronous method.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aPasswordThe password. The maximum length is 64 characters. Ensure that you set this parameter.
aCompletionBlockThe completion block, which contains the username and the error message if the method fails.

◆ loginWithUsername:token:

- (AgoraChatError *_Nullable) loginWithUsername: (NSString *_Nonnull)  aUsername
token: (NSString *_Nonnull)  aToken 

A user logs in to the chat server with a token. This method does not support automatic isLoggedIn.

This is a synchronous method and blocks the current thread.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aTokenThe token for user logging in to Chat server.
Returns
Returns nil on success, and the description of the issue that cause the call to fail.

◆ loginWithUsername:token:completion:

- (void) loginWithUsername: (NSString *_Nonnull)  aUsername
token: (NSString *_Nonnull)  aToken
completion: (void(^)(NSString *_Nonnull aUsername, AgoraChatError *_Nullable aError))  aCompletionBlock 

A user logs in to the chat server with a token. This method support automatic login.

This is an asynchronous method.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aTokenThe token for logging in to the chat server.
aCompletionBlockThe completion block, which contains the username and the error message if the method fails.

◆ logout:

- (AgoraChatError *_Nullable) logout: (BOOL)  aIsUnbindDeviceToken

A user logs out of the chat server.

This is a synchronous method and blocks the current thread.

Parameters
aIsUnbindDeviceTokenWhether to unbind the username from the device(Set to YES to unbind the user currently logged into the app from this device). That stops the user device receiving push notifications from the Apple Push Notifications service.
Returns
A description of the issue that caused this call to fail.

◆ logout:completion:

- (void) logout: (BOOL)  aIsUnbindDeviceToken
completion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock 

A user logs out of the chat server.

This is an asynchronous method.

Parameters
aIsUnbindDeviceTokenWhether to unbind the username from the device. If you unbind the username from the device (setting this parameter as YES) and logs out, the device no longer receives messages from the Apple Push Notification Service.
aCompletionBlockThe completion block, which contains the token and the error message if the method fails.

◆ migrateDatabaseToLatestSDK

- (BOOL) migrateDatabaseToLatestSDK

Migrate the chat database to the latest SDK version.

This is a synchronous method and blocks the current thread.

Returns
Returns YES for success and the description of the cause if the method fails.

◆ registerForRemoteNotificationsWithDeviceToken:completion:

- (void) registerForRemoteNotificationsWithDeviceToken: (NSData *_Nonnull)  aDeviceToken
completion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock 

Device token binding is required to enable Apple push notification service.

Parameters
aDeviceTokenThe device token to bind.
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ registerPushKitToken:completion:

- (void) registerPushKitToken: (NSData *_Nullable)  aPushToken
completion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock 

Register a pushkit token, this is required to enable Apple PushKit Service, which is for VOIP CALL.

This is an asynchronous method.

Parameters
aPushTokenThe pushkit token to bind.
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ registerWithUsername:password:

- (AgoraChatError *_Nullable) registerWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword 

Register a new user with your chat network.

After you call initializeSDKWithOptions and register your app in console, the app has access to all the features registered inside your chat network. You add and remove users inside your chat network; depending on how you implement your app, you control the people each user can see inside your network.

This is a synchronous method and blocks the current thread. To ensure registration reliability, we recommend using the REST API to register new chat users.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aPasswordThe password. The maximum length is 64 characters. Ensure that you set this parameter.
Returns
A description of the issue that caused this call to fail.

◆ registerWithUsername:password:completion:

- (void) registerWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(NSString *_Nonnull aUsername, AgoraChatError *_Nullable aError))  aCompletionBlock 

Register a new user with your chat network.

This is an asynchronous method.

After you call initializeSDKWithOptions and register your app in console, the app has access to all the features registered inside your chat network. You add and remove users inside your chat network; depending on how you implement your app, you control the people each user can see inside your network.

To ensure registration reliability, we recommend using the REST API to register new chat users.

Parameters
aUsernameThe username. The maximum length is 64 characters. Ensure that you set this parameter. Supported characters include the 26 English letters (a-z), the ten numbers (0-9), the underscore (_), the hyphen (-), and the English period (.). This parameter is case insensitive, and upper-case letters are automatically changed to low-case ones. If you want to set this parameter as a regular expression, set it as ^[a-zA-Z0-9_-]+$.
aPasswordThe password. The maximum length is 64 characters. Ensure that you set this parameter.
aCompletionBlockThe completion block, which contains the username and the error message if the method fails.

◆ removeDelegate:

- (void) removeDelegate: (id _Nonnull)  aDelegate

Remove the delegate.

Parameters
aDelegateThe delegate that you want to remove.

◆ removeLogDelegate:

- (void) removeLogDelegate: (removeLog(delegate:))  NS_SWIFT_NAME

Remove the log callback delegate.

Parameters
aDelegateThe log callback delegate that you want to delete.

◆ removeMultiDevicesDelegate:

- (void) removeMultiDevicesDelegate: (id< AgoraChatMultiDevicesDelegate >_Nonnull)  aDelegate

Remove the multi-device delegate.

Parameters
aDelegateThe multi-device delegate that you want to delete.

◆ renewToken:

- (AgoraChatError *_Nullable) renewToken: (NSString *_Nonnull)  newAgoraToken

Renews the token when the current token expires.

The token expires after a period of time once the token schema is enabled when:

  • The SDK triggers the onTokenPrivilegeWillExpire callback, or
  • The onConnectionStateChanged callback reports the CONNECTION_CHANGED_TOKEN_EXPIRED(9) error.

The app should retrieve a new token from the server and call this method to renew it. Failure to do so results in the SDK disconnecting from the server.

This is a synchronous method and blocks the current thread.

Parameters
newAgoraTokenThe new Agora Chat token。
Returns
The result which contains the description of the cause to the failure if call fails.

◆ serviceCheckWithUsername:password:completion:

- (void) serviceCheckWithUsername: (NSString *_Nonnull)  aUsername
password: (NSString *_Nonnull)  aPassword
completion: (void(^)(AgoraChatServerCheckType aType, AgoraChatError *_Nullable aError))  aCompletionBlock 

Run the server diagnostic tests for Agora Chat for a specific user. These tests are run in the order defined by AgoraChatServerCheckType. If the user is logged in, the login account is used by default.

This is an asynchronous method.

Parameters
aUsernameThe username.
aPasswordThe password.
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ sharedClient

+ (instancetype _Nonnull) sharedClient

Creates a Client instance. The Client class is the entry to the Chat SDK. You need to call this method to create a Client instance before calling any other method.

◆ unBindPushKitToken

- (AgoraChatError *_Nullable) unBindPushKitToken

Unbind the Apple PushKit token.

This is a synchronous method and blocks the current thread.

Returns
A description of the issue that caused this call to fail.

◆ unRegisterPushKitTokenWithCompletion:

- (void) unRegisterPushKitTokenWithCompletion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock

Unregister the Apple PushKit token.

Parameters
aCompletionBlockThe completion block, which contains the error message if the method fails.

◆ uploadDebugLogToServerWithCompletion:

- (void) uploadDebugLogToServerWithCompletion: (void(^)(AgoraChatError *_Nullable aError))  aCompletionBlock

Upload debugging log to server.

Parameters
aCompletionBlockThe completion block, which contains the token and the error message if the method fails.

◆ uploadLogToServer

- (AgoraChatError *_Nullable) uploadLogToServer

Upload the log to the chat server. The information in the debug log is used by our engineers to fix errors and improve system performance. Make sure to use the AgoraChatLog class.

This is a synchronous method and blocks the current thread.

Returns
Returns nil on success, and error on failure which contains the description of the issue that cause the call to fail_Nullable.

◆ version

- (NSString *) version

The SDK version number.

Property Documentation

◆ accessUserToken

- (NSString* _Nullable) accessUserToken
readnonatomicassign

The token for accessing the current chat.

◆ chatManager

- (id<IAgoraChatManager> _Nullable) chatManager
readnonatomicstrong

The chat manager module.

◆ contactManager

- (id<IAgoraChatContactManager> _Nullable) contactManager
readnonatomicstrong

The contact manager module.

◆ currentUsername

- (NSString* _Nullable) currentUsername
readnonatomicstrong

The ID of the user currently logged into your chat app.

◆ groupManager

- (id<IAgoraChatGroupManager> _Nullable) groupManager
readnonatomicstrong

The group manager module.

◆ isAutoLogin

- (BOOL) isAutoLogin
readnonatomicassign

Whether to let a user automatically log in to the chat server with the username used in the previous session. If the login fails, for example, because of a wrong password or the username deactivated, the isAutoLogin parameter is reset to NO, and you need to set it back to YES to allow automatic login.

◆ isConnected

- (BOOL) isConnected
readnonatomicassign

Whether the SDK is connected to the chat server.

◆ isLoggedIn

- (BOOL) isLoggedIn
readnonatomicassign

Returns true if the current user is logged in.

◆ options

- (AgoraChatOptions* _Nonnull) options
readnonatomicstrong

The SDK setting options. For example, whether to use https by default.

◆ presenceManager

- (id<IAgoraChatPresenceManager> _Nullable) presenceManager
readnonatomicstrong

The presence manager module.

◆ pushManager

- (id<IAgoraChatPushManager> _Nullable) pushManager
readnonatomicstrong

The push manager module.

◆ roomManager

- (id<IAgoraChatroomManager> _Nullable) roomManager
readnonatomicstrong

The chat room manager module.

◆ threadManager

- (id<IAgoraChatThreadManager> _Nullable) threadManager
readnonatomicstrong

Thread Management

◆ userInfoManager

- (id<IAgoraChatUserInfoManager> _Nullable) userInfoManager
readnonatomicstrong

The user attributes manager module.

◆ version

- (NSString* _Nonnull) version
readnonatomicstrong

The SDK version number.


The documentation for this class was generated from the following file: