Package io.agora.rtm
Enum Class RtmConstants.RtmConnectionChangeReason
java.lang.Object
java.lang.Enum<RtmConstants.RtmConnectionChangeReason>
io.agora.rtm.RtmConstants.RtmConnectionChangeReason
- All Implemented Interfaces:
Serializable,Comparable<RtmConstants.RtmConnectionChangeReason>,Constable
- Enclosing class:
- RtmConstants
public static enum RtmConstants.RtmConnectionChangeReason
extends Enum<RtmConstants.RtmConnectionChangeReason>
Reasons for connection state change.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum ConstantsEnum ConstantDescription3: The connection between the SDK and the server is banned by the server.22: The connection is failed due to certification verify failure.13: The IP Address of the app has changed.18: The local IP Address is changed by user.0: The SDK is connecting to the server.17: The change of connection state is caused by echo test.24: The connection is failed due to token and appid inconsistent.2: The connection between the SDK and the server is interrupted.6: The connection fails because the App ID is not valid.7: The connection fails because the channel name is not valid.8: The connection fails because the token is not valid.4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.1: The SDK has joined the channel successfully.14: A timeout occurs for the keep-alive of the connection between the SDK and the server.5: The SDK has left the channel.21: The connection is failed due to license validation failure.10001: The connection of rtm edge service has been successfully established.10002: User log out Agora RTM system.16: The connection between the SDK and the server is lost.10003: User log out Agora RTM system.10: The connection is rejected by the server.15: The SDK has rejoined the channel successfully.12: When the connection state changes because the app has renewed the token.19: The connection is failed due to join the same channel on another device with the same uid.11: The connection changes to reconnecting because the SDK has set a proxy server.23: The connection is failed due to user vid not support stream channel.9: The connection fails because the token has expired.20: The connection is failed due to too many broadcasters in the channel. -
Method Summary
Modifier and TypeMethodDescriptionstatic intReturns the enum constant of this class with the specified name.values()Returns an array containing the constants of this enum class, in the order they are declared.Methods inherited from class java.lang.Enum
compareTo, describeConstable, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
-
Enum Constant Details
-
CONNECTING
0: The SDK is connecting to the server. -
JOIN_SUCCESS
1: The SDK has joined the channel successfully. -
INTERRUPTED
2: The connection between the SDK and the server is interrupted. -
BANNED_BY_SERVER
3: The connection between the SDK and the server is banned by the server. -
JOIN_FAILED
4: The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel. -
LEAVE_CHANNEL
5: The SDK has left the channel. -
INVALID_APP_ID
6: The connection fails because the App ID is not valid. -
INVALID_CHANNEL_NAME
7: The connection fails because the channel name is not valid. -
INVALID_TOKEN
8: The connection fails because the token is not valid. -
TOKEN_EXPIRED
9: The connection fails because the token has expired. -
REJECTED_BY_SERVER
10: The connection is rejected by the server. -
SETTING_PROXY_SERVER
11: The connection changes to reconnecting because the SDK has set a proxy server. -
RENEW_TOKEN
12: When the connection state changes because the app has renewed the token. -
CLIENT_IP_ADDRESS_CHANGED
13: The IP Address of the app has changed. A change in the network type or IP/Port changes the IP address of the app. -
KEEP_ALIVE_TIMEOUT
14: A timeout occurs for the keep-alive of the connection between the SDK and the server. -
REJOIN_SUCCESS
15: The SDK has rejoined the channel successfully. -
LOST
16: The connection between the SDK and the server is lost. -
ECHO_TEST
17: The change of connection state is caused by echo test. -
CLIENT_IP_ADDRESS_CHANGED_BY_USER
18: The local IP Address is changed by user. -
SAME_UID_LOGIN
19: The connection is failed due to join the same channel on another device with the same uid. -
TOO_MANY_BROADCASTERS
20: The connection is failed due to too many broadcasters in the channel. -
LICENSE_VALIDATION_FAILURE
21: The connection is failed due to license validation failure. -
CERTIFICATION_VERIFY_FAILURE
22: The connection is failed due to certification verify failure. -
STREAM_CHANNEL_NOT_AVAILABLE
23: The connection is failed due to user vid not support stream channel. -
INCONSISTENT_APPID
24: The connection is failed due to token and appid inconsistent. -
LOGIN_SUCCESS
10001: The connection of rtm edge service has been successfully established. -
LOGOUT
10002: User log out Agora RTM system. -
PRESENCE_NOT_READY
10003: User log out Agora RTM system.
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getValue
-
getEnum
-