ConnectionChangedReason enum

Reasons for the connection state change.

Inheritance

• Object
• Enum
• ConnectionChangedReason

Constructors

ConnectionChangedReason()

const

Values

Connecting → const ConnectionChangedReason

The SDK is connecting to Agora’s edge server.

JoinSuccess → const ConnectionChangedReason

The SDK has joined the channel successfully.

Interrupted → const ConnectionChangedReason

The connection between the SDK and Agora’s edge server is interrupted.

BannedByServer → const ConnectionChangedReason

The connection between the SDK and Agora’s edge server is banned by Agora’s edge server.

JoinFailed → const ConnectionChangedReason

The SDK fails to join the channel for more than 20 minutes and stops reconnecting to the channel.

LeaveChannel → const ConnectionChangedReason

The SDK has left the channel.

InvalidAppId → const ConnectionChangedReason

The specified App ID or Token is invalid. Try to rejoin the channel with a valid App ID or Token.

InvalidChannelName → const ConnectionChangedReason

The specified channel name is invalid. Try to rejoin the channel with a valid channel name.

InvalidToken → const ConnectionChangedReason

The generated token is invalid probably due to the following reasons:

• The App Certificate for the project is enabled in Console, but you do not use Token when joining the channel. If you enable the App Certificate, you must use a token to join the channel.
• The uid that you specify in the RtcEngine.joinChannel method is different from the uid that you pass for generating the token.

TokenExpired → const ConnectionChangedReason

The token has expired. Generate a new token from your server.

RejectedByServer → const ConnectionChangedReason

The user is banned by the server.

SettingProxyServer → const ConnectionChangedReason

The SDK tries to reconnect after setting a proxy server.

RenewToken → const ConnectionChangedReason

The token renews.

ClientIpAddressChanged → const ConnectionChangedReason

The client IP address has changed, probably due to a change of the network type, IP address, or network port.

KeepAliveTimeout → const ConnectionChangedReason

Timeout for the keep-alive of the connection between the SDK and Agora’s edge server. The connection state changes to:

• ConnectionStateType.Reconnecting

ProxyServerInterrupted → const ConnectionChangedReason

In cloud proxy mode, the proxy server connection interrupted.

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<ConnectionChangedReason>

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