TelnyxClient class

The TelnyxClient class that can be used to control the SDK. Such as connect, disconnect, check gateway status or create instance of Call

Constructors

TelnyxClient({String ringtonePath = '', String ringBackpath = ''})

Properties

call Call
no setter
earlySDP bool
getter/setter pair
hashCode int
The hash code for this object.
no setterinherited
onSocketErrorReceived OnSocketErrorReceived
getter/setter pair
onSocketMessageReceived OnSocketMessageReceived
getter/setter pair
ringBackpath String
getter/setter pair
ringtonePath String
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
sessid String
The current session ID related to this client
getter/setter pair
storedCredentialConfig CredentialConfig?
getter/setter pair
storedTokenConfig TokenConfig?
getter/setter pair
txSocket TxSocket
getter/setter pair

Methods

connect() → void
credentialLogin(CredentialConfig config) → void
Uses the provided config to send a credential login message to the Telnyx backend. If successful, the gateway registration process will start.
disconnect() → void
Closes the socket connection, effectively logging the user out.
getGatewayStatus() String
Returns the current Gateway state for the socket connection
handlePushNotification(PushMetaData pushMetaData, CredentialConfig? credentialConfig, TokenConfig? tokenConfig) → void
isConnected() bool
Returns whether or not the client is connected to the socket connection
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
tokenLogin(TokenConfig config) → void
Uses the provided config to send a token login message to the Telnyx backend. If successful, the gateway registration process will start.
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited

Constants

GATEWAY_RESPONSE_DELAY → const int
RETRY_CONNECT_TIME → const int
RETRY_REGISTER_TIME → const int