ConnectionChangedReasonType enum

Reasons causing the change of the connection state.

Inheritance

• Object
• Enum
• ConnectionChangedReasonType

Annotations

• @JsonEnum(alwaysCreate: true)

Constructors

ConnectionChangedReasonType()

const

Values

connectionChangedConnecting → const ConnectionChangedReasonType

0: The SDK is connecting to the Agora edge server.

connectionChangedJoinSuccess → const ConnectionChangedReasonType

1: The SDK has joined the channel successfully.

connectionChangedInterrupted → const ConnectionChangedReasonType

2: The connection between the SDK and the Agora edge server is interrupted.

connectionChangedBannedByServer → const ConnectionChangedReasonType

3: The connection between the SDK and the Agora edge server is banned by the Agora edge server. This error occurs when the user is kicked out of the channel by the server.

connectionChangedJoinFailed → const ConnectionChangedReasonType

4: The SDK fails to join the channel. When the SDK fails to join the channel for more than 20 minutes, this error occurs and the SDK stops reconnecting to the channel.

connectionChangedLeaveChannel → const ConnectionChangedReasonType

5: The SDK has left the channel.

connectionChangedInvalidAppId → const ConnectionChangedReasonType

6: The connection failed because the App ID is not valid. Please rejoin the channel with a valid App ID.

connectionChangedInvalidChannelName → const ConnectionChangedReasonType

7: The connection failed since channel name is not valid. Rejoin the channel with a valid channel name.

connectionChangedInvalidToken → const ConnectionChangedReasonType

8: The connection failed because the token is not valid. Possible reasons are as follows: The App Certificate for the project is enabled in Agora Console, but you do not use a token when joining the channel. If you enable the App Certificate, you must use a token to join the channel. The uid specified when calling joinChannel to join the channel is inconsistent with the uid passed in when generating the token.

connectionChangedTokenExpired → const ConnectionChangedReasonType

9: The connection failed since token is expired.

connectionChangedRejectedByServer → const ConnectionChangedReasonType

10: The connection is rejected by server. Possible reasons are as follows: The user is already in the channel and still calls a method, for example, joinChannel, to join the channel. Stop calling this method to clear this error. The user tries to join a channel while a test call is in progress. The user needs to join the channel after the call test ends.

connectionChangedSettingProxyServer → const ConnectionChangedReasonType

11: The connection state changed to reconnecting because the SDK has set a proxy server.

connectionChangedRenewToken → const ConnectionChangedReasonType

12: The connection state changed because the token is renewed.

connectionChangedClientIpAddressChanged → const ConnectionChangedReasonType

13: The IP address of the client has changed, possibly because the network type, IP address, or port has been changed.

connectionChangedKeepAliveTimeout → const ConnectionChangedReasonType

14: Timeout for the keep-alive of the connection between the SDK and the Agora edge server. The SDK tries to reconnect to the server automatically.

connectionChangedRejoinSuccess → const ConnectionChangedReasonType

15: The user has rejoined the channel successfully.

connectionChangedLost → const ConnectionChangedReasonType

16: The connection between the SDK and the server is lost.

connectionChangedEchoTest → const ConnectionChangedReasonType

17: The connection state changes due to the echo test.

connectionChangedClientIpAddressChangedByUser → const ConnectionChangedReasonType

18: The local IP address was changed by the user.

connectionChangedSameUidLogin → const ConnectionChangedReasonType

19: The user joined the same channel from different devices with the same UID.

connectionChangedTooManyBroadcasters → const ConnectionChangedReasonType

20: The number of hosts in the channel has reached the upper limit.

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<ConnectionChangedReasonType>

A constant List of the values in this enum, in order of their declaration.