<AgoraChatClientDelegate> Protocol Reference

#import <AgoraChatClientDelegate.h>

Inheritance diagram for <AgoraChatClientDelegate>:

Instance Methods
(void)	- connectionStateDidChange:
(void)	- autoLoginDidCompleteWithError:
(void)	- userAccountDidLoginFromOtherDevice:
(void)	- userAccountDidLoginFromOtherDeviceWithInfo:
(void)	- userAccountDidRemoveFromServer
(void)	- userDidForbidByServer
(void)	- userAccountDidForcedToLogout:
(void)	- tokenWillExpire:
(void)	- tokenDidExpire:
(void)	- onOfflineMessageSyncStart
(void)	- onOfflineMessageSyncFinish
(3_1_0, 4_1_0, "Use userAccountDidLoginFromOtherDevice: instead")	- EM_DEPRECATED_IOS

Detailed Description

@abstract This protocol provides a number of utility classes callback

Method Documentation

autoLoginDidCompleteWithError:

- (void) autoLoginDidCompleteWithError: (AgoraChatError *_Nullable)  aError

optional

Occurs when the auto login is completed.

Parameters

aError

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

connectionStateDidChange:

- (void) connectionStateDidChange: (AgoraChatConnectionState)  aConnectionState

optional

Occurs when the connection state between the SDK and the server changes.

The SDK triggers this callback in any of the following situations:

• After login, the device is disconnected from the internet.
• After login, the network status changes.

Parameters

aConnectionState

The current connection state.

EM_DEPRECATED_IOS

- (3_1_0, 4_1_0, "Use) userAccountDidLoginFromOtherDevice:

optional

Occurs when the current user account is logged in to another device.

onOfflineMessageSyncFinish

- (void) onOfflineMessageSyncFinish

optional

Occurs when the SDK finishes pulling offline messages from the server.

onOfflineMessageSyncStart

- (void) onOfflineMessageSyncStart

optional

Occurs when the SDK starts pulling offline messages from the server.

tokenDidExpire:

- (void) tokenDidExpire: (AgoraChatErrorCode)  aErrorCode

optional

token did expire (log in using agoraToken)

tokenWillExpire:

- (void) tokenWillExpire: (AgoraChatErrorCode)  aErrorCode

optional

token will expire (log in using agoraToken)

userAccountDidForcedToLogout:

- (void) userAccountDidForcedToLogout: (AgoraChatError *_Nullable)  aError

optional

The delegate method will be invoked when current IM account is forced to logout with the following reasons:

1. The password is modified;
2. Logged in too many devices;
3. User for forbidden;
4. Forced offline.

userAccountDidLoginFromOtherDevice:

- (void) userAccountDidLoginFromOtherDevice: (4_1_0)  (4_7_0)  ("Use userAccountDidLoginFromOtherDeviceWithInfo: instead")  EM_DEPRECATED_IOS

optional

Occurs when the current user account is logged in to another device.

Parameters

aDeviceName

The name of the new login device.

userAccountDidLoginFromOtherDeviceWithInfo:

- (void) userAccountDidLoginFromOtherDeviceWithInfo: (AgoraChatLoginExtensionInfo *_Nullable)  info

optional

Occurs when the current user account is logged in to another device.

Parameters

info	The device name and extended information of the login device AgoraChatLoginInfo.

userAccountDidRemoveFromServer

- (void) userAccountDidRemoveFromServer

optional

Occurs when the current chat user is removed from the server.

userDidForbidByServer

- (void) userDidForbidByServer

optional

The delegate method will be invoked when the User account is forbidden.

---

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

• AgoraChat.framework/Headers/AgoraChatClientDelegate.h