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`	required	Project ID from your SignalWire Space
`Token`	`string`	required	Token from your SignalWire Space
`Host`	`string`	optional	The endpoint URI to send requests to. The SignalWire Space URL, should be a string similar `{your-space}.signalwire.com`.
`signalwireContexts`	`string`	optional	List of Contexts for inbound

Examples

Create a Client to interact with the RELAY API.

1 signalwireContexts := []string{DefaultContext}
2 
3 client := signalwire.Client(PProjectID, PTokenID, "" /*host, empty for default*/, signalwireContexts)

Properties

Property	Type	Description
`calling`	`Relay.Calling`	Returns a `Relay.Calling` instance associated with the client.
`messaging`	`Relay.Messaging`	Returns a `Relay.Messaging` instance associated with the client.
`tasking`	`Relay.Tasking`	Returns a `Relay.Tasking` instance associated with the client.

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

error

Examples

1 signalwireContexts := []string{DefaultContext}
2 
3 client := signalwire.Client(PProjectID, PTokenID, "" /*host, empty for default*/, signalwireContexts)
4 // register callback, anonymous function
5 client.OnReady = func (client *signalwire.ClientSession) {
6 	signalwire.Log.Info("Client connected\n")
7 }
8 // start
9 err := client.Connect()
10 if err != nil {
11 	signalwire.Log.Error("Error occurred while starting Signalwire Client\n")
12 }

Disconnect()

Disconnect the client from RELAY.

Returns

error

Examples

1 if err := client.Disconnect(); err != nil {
2 	signalwire.Log.Error("Error occurred while trying to disconnect Client\n")
3 }

Events

All available events you can attach a listener on.

Property	Description
`OnReady`	The session has been established and all other methods can now be used.