Skip to main content

​
OnSocketMethodReceived

The OnSocketMethodReceived event handler is a callback function that is called when a message is received from the Telnyx WebSocket connection. The message is passed as a parameter to the callback function. 
typedef OnSocketMessageReceived = void Function(TelnyxMessage message);

​
TelnyxMessage

This class is used to represent a message received from the Telnyx Socket. It contains a socketMethod which is a string representing the type of message received and a ReceivedMessage which contains the message data. 
class TelnyxMessage {
  String socketMethod;
  ReceivedMessage message;

  TelnyxMessage({required this.socketMethod, required this.message});
}

​
Socket Methods

The socket method can be one of the following: 
class SocketMethod {
  static const answer = 'telnyx_rtc.answer';
  static const invite = 'telnyx_rtc.invite';
  static const bye = 'telnyx_rtc.bye';
  static const modify = 'telnyx_rtc.modify';
  static const media = 'telnyx_rtc.media';
  static const info = 'telnyx_rtc.info';
  static const ringing = 'telnyx_rtc.ringing';
  static const clientReady = 'telnyx_rtc.clientReady';
  static const gatewayState = 'telnyx_rtc.gatewayState';
  static const ping = 'telnyx_rtc.ping';
  static const login = 'login';
  static const attachCall = 'telnyx_rtc.attachCalls';
  static const attach = 'telnyx_rtc.attach';
}

​
ReceivedMessage

The received message contains the data of the message received from the Telnyx Socket. It will contain the actual message as well as the state of the Call, client and SDK.