RELAY Client | SignalWire

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

Parameter	Type	Required	Description
`project`	String	Yes	Project ID from your SignalWire Space
`token`	String	Yes	Token from your SignalWire Space

Examples

Create a Client to interact with the RELAY API.

1 Signalwire::Relay::Client.new(project: "your-project-id", token: "your-project-token")

Properties

Property	Type	Description
`connected`	Boolean	Returns `true` if the client has connected to RELAY.
`calling`	`Relay::Calling`	Returns a `Relay::Calling` instance associated with the client.
`messaging`	`Relay::Messaging`	Returns a `Relay::Messaging` instance associated with the client.

Methods

connect!

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

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

nil

Examples

1 client.disconnect!

on

Attach an event handler for a specific type of event.

Parameters

Parameter	Type	Required	Description
`event`	Symbol	Yes	Event name. Full list of events RELAY Client Events
`guards`	Array	No	Guard clauses for the event.
`handler`	Block	No	Block to call when the event is received. It will be passed in as an argument.

Returns

String - A low-level handler ID.

Examples

Subscribe to the ready event.

1 client.on :ready do
2   # do something on ready
3 end

Events

All available events you can attach a listener on.

Event	Description
`:ready`	The session has been established and all other methods can now be used.
`:event`	The session has received a Relay event.