AgoraRtmSendPeerMessageErrorCode Constants Reference

Declared in	AgoraRtmKit.h

Error codes related to sending a peer-to-peer message.

Definition

typedef NS_ENUM(NSInteger, AgoraRtmSendPeerMessageErrorCode ) {


                   AgoraRtmSendPeerMessageErrorOk = 0,


                   AgoraRtmSendPeerMessageErrorFailure = 1,


                   AgoraRtmSendPeerMessageErrorTimeout = 2,


                   AgoraRtmSendPeerMessageErrorPeerUnreachable = 3,


                   AgoraRtmSendPeerMessageErrorCachedByServer = 4,


                   AgoraRtmSendPeerMessageErrorTooOften = 5,


                   AgoraRtmSendPeerMessageErrorInvalidUserId = 6,


                   AgoraRtmSendPeerMessageErrorInvalidMessage = 7,


                   AgoraRtmSendPeerMessageErrorImcompatibleMessage = 8,


                   AgoraRtmSendPeerMessageErrorNotInitialized = 101,


                   AgoraRtmSendPeerMessageErrorNotLoggedIn = 102,


                };

Constants

AgoraRtmSendPeerMessageErrorOk

0: The specified user receives the peer-to-peer message.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorFailure

1: The user fails to send the peer-to-peer message.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorTimeout

2: A timeout occurs when sending the peer-to-peer message. The current timeout is set as 10 seconds. Possible reasons: The user is in the AgoraRtmConnectionStateAborted or AgoraRtmConnectionStateReconnecting state.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorPeerUnreachable

3: The user is offline and has not received the peer-to-peer message.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorCachedByServer

4: The specified user is offline and does not receive the peer-to-peer message, but the server has cached the message and will send the message to the specified user when he/she is back online.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorTooOften

5: The method call frequency exceeds the limit of 180 calls every three seconds (channel and peer messages taken together).

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorInvalidUserId

6: The user ID is invalid.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorInvalidMessage

7: The message is null or exceeds 32 KB in length.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorImcompatibleMessage

8: The message receiver‘s SDK is of an earlier version and hence cannot recognize this message.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorNotInitialized

101: The SDK is not initialized.

Declared In AgoraRtmKit.h.

AgoraRtmSendPeerMessageErrorNotLoggedIn

102: The sender does not call the loginByToken method, or the method call of loginByToken does not succeed before sending the peer-to-peer message.

Declared In AgoraRtmKit.h.