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
project | string | required | Project ID from your SignalWire Space |
token | string | required | Token from your SignalWire Space |
Examples
<?php
$client = new SignalWire\Relay\Client([
'project' => 'XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX',
'token' => 'PTXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX'
]);
Properties
calling | Relay.Calling | Returns a Relay.Calling 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.
Available In:
Returns
void
Examples
<?php
$client->connect();
disconnect
Disconnect the client from Relay.
Available In:
Returns
void
Examples
<?php
$client->disconnect();
on
Attach an event handler for a specific type of event.
Available In:
Parameters
$event | string | required | Event name. Full list of events Relay.Client Events |
$callback | function | required | Callable to invoke when the event comes. |
Returns
Relay.Client
- The client object itself.
Examples
<?php
$client->on('signalwire.ready', function($client) {
// Your client is ready!
})->on('signalwire.error', function(\Exception $error) {
// Got an error...
});
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
$event | string | required | Event name. Full list of events Relay.Client Events |
$callback | function | optional | Callable to remove. Note: $callback will be removed from the stack by reference so make sure to use the same reference in both .on() and .off() methods. |
Returns
Relay.Client
- The client object itself.
Examples
<?php
$errorHandler = function($error) {
// Log the error..
};
$client->on('signalwire.error', $errorHandler);
// .. later
$client->off('signalwire.error', $errorHandler);
Events
All available events you can attach a listener on.
signalwire.ready | The session has been established and all other methods can now be used. |
signalwire.error | There is an error dispatch at the session level. |
signalwire.socket.open | The websocket is open. However, you have not yet been authenticated. |
signalwire.socket.error | The websocket gave an error. |
signalwire.socket.message | The client has received a message from the websocket. |
signalwire.socket.close | The websocket is closing. |