Documentation
Real-time Messaging
API Reference
Agora RTM Java API Reference for Android
Agora RTM Java API Reference for Android
◆ 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.
◆ 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 10 seconds. Possible reasons: The user is in the CONNECTION_STATE_ABORTED or CONNECTION_STATE_RECONNECTING state.
◆ 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 the receiver 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 (RTM SDK for Android Java) 180 calls every 3 seconds or (RTM SDK for Linux Java) 1500 calls every three seconds, with channel messages and peer-to-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_IMCOMPATIBLE_MESSAGE
int io.agora.rtm.RtmStatusCode.PeerMessageError.PEER_MESSAGE_ERR_IMCOMPATIBLE_MESSAGE = 8 |
8: The message receiver‘s SDK is of an earlier version and hence cannot recognize this message.
◆ 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.