Documentation
Real-time Messaging
Agora RTM Web API Reference
Index
AgoraRTM
RtmClient
RtmMessage
RtmChannel
LocalInvitation
RemoteInvitation
RtmEvents
RtmErrorCode
RtmStatusCode
Index
Enumeration members
Enumeration members
ABORTED
CONNECTED
The SDK has logged in the Agora RTM system.
- If the connection between the SDK and the Agora RTM system is interrupted because of network issues, the SDK triggers the ConnectionStateChanged callback and switches to the RECONNECTING state.
- If the login is banned by the server, for example, another instance has logged in with the same uid from a different device, the SDK triggers the ConnectionStateChanged callback and switches to the ABORTED state.
- If the app calls the RtmClient.logout method and the SDK successfully logs out of the Agora RTM system, the SDK triggers the ConnectionStateChanged callback and switches to the DISCONNECTED state.
CONNECTING
The SDK has logged in the Agora RTM system.
- Success = the SDK triggers the ConnectionStateChanged callback and switches to the CONNECTED state.Failure = the SDK triggers the ConnectionStateChanged callback and switches to the DISCONNECTED state.
DISCONNECTED
When the app calls the login method, the SDK logs in the Agora RTM system, triggers the ConnectionStateChanged callback, and switches to the CONNECTING state.
RECONNECTING
The SDK keeps logging in the Agora RTM system.
- If the SDK successfully logs in the Agora RTM system again, it triggers the ConnectionStateChanged callback and switches to the CONNECTED state.
- If the SDK fails to log in the Agora RTM system again, the SDK stays in the RECONNECTING state.
- If the login is rejected by the server, the SDK triggers the ConnectionStateChanged callback and switches to the ABORTED state.
Connection states between the SDK and the Agora RTM system.