Relay.Client

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

Constructor

Constructs a client object to interact with RELAY.

Parameters

Example

Create a Client to interact with the RELAY API.

1
const client = new RelayClient({
2
  project: 'my-project-id',
3
  token: 'my-project-token'
4
})

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

Promise<void>

Example

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

disconnect

Disconnect the client from RELAY.

Returns

void

Example

1
client.disconnect()

on

Attach an event handler for a specific type of event.

Parameters

Returns

Relay.Client - The client object itself.

Example

Subscribe to the signalwire.ready and signalwire.error events.

1
client.on('signalwire.ready', (client) => {
2
  // Your client is ready!
3
}).on('signalwire.error', (error) => {
4
  // Got an error...
5
})

off

Remove an event handler that were attached with .on(). If no handler parameter is passed, all listeners for that event will be removed.

Parameters

Returns

Relay.Client - The client object itself.

Example

Subscribe to the signalwire.error and then, remove the event handler.

1
const errorHandler = (error) => {
2
  // Log the error..
3
}
4
5
client.on('signalwire.error', errorHandler)
6
7
// .. later
8
client.off('signalwire.error', errorHandler)

Events

All available events you can attach a listener on.