SignalWire.Relay.Client

SignalWire.Relay.Client is the basic connection to RELAY, allowing you send commands to RELAY and set up handlers for inbound events.

Constructor

Constructs a client object to interact with RELAY.

Parameters

Examples

Create a Client to interact with the RELAY API.

1
Client client = new Client("my-project-id", "my-project-token");

Properties

Methods

Connect

Activates the connection to the RELAY API. The connection to RELAY does not happen automatically so that you can setup handlers to events that might occur before the connection is successfully established.

Returns

void

Examples

1
// Make sure you have attached the listeners you need before connecting the client, or you might miss some events.
2
client.Connect()

Disconnect

Disconnect the client from RELAY.

Returns

void

Examples

1
client.Disconnect()

Events

All available events you can attach a listener on.