Public Attributes

int PEER_MESSAGE_ERR_OK = 0
 
int PEER_MESSAGE_ERR_FAILURE = 1
 
int PEER_MESSAGE_ERR_TIMEOUT = 2
 
int PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3
 
int PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4
 
int PEER_MESSAGE_ERR_TOO_OFTEN = 5
 
int PEER_MESSAGE_ERR_INVALID_USERID = 6
 
int PEER_MESSAGE_ERR_INVALID_MESSAGE = 7
 
int PEER_MESSAGE_ERR_NOT_INITIALIZED = 101
 
int PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102
 

Member Data Documentation

◆ PEER_MESSAGE_ERR_OK

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_OK = 0

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

◆ PEER_MESSAGE_ERR_FAILURE

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_FAILURE = 1

1: The user fails to send the peer-to-peer message, possibly because the connection between the SDK and the Agora RTM system is interrupted and the SDK is in the CONNECTION_STATE_RECONNECTING state.

◆ PEER_MESSAGE_ERR_TIMEOUT

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_TIMEOUT = 2

2: A timeout occurs when sending the peer-to-peer message. The current timeout is set as five seconds.

◆ PEER_MESSAGE_ERR_PEER_UNREACHABLE

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_PEER_UNREACHABLE = 3

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

◆ PEER_MESSAGE_ERR_CACHED_BY_SERVER

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_CACHED_BY_SERVER = 4

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

◆ PEER_MESSAGE_ERR_TOO_OFTEN

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_TOO_OFTEN = 5

5: The method call frequency exceeds the limit of 60 queries per second (channel and peer messages taken together).

◆ PEER_MESSAGE_ERR_INVALID_USERID

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_INVALID_USERID = 6

6: The user ID is invalid.

◆ PEER_MESSAGE_ERR_INVALID_MESSAGE

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_INVALID_MESSAGE = 7

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

◆ PEER_MESSAGE_ERR_NOT_INITIALIZED

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_NOT_INITIALIZED = 101

101: The SDK is not initialized.

◆ PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN

int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_USER_NOT_LOGGED_IN = 102

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