Task.Client
A Task client. On your server, use instances of this client to receive data emitted with Task.send.
Example​
const client = new Task.Client({
project: "<project-id>",
token: "<api-token>",
topics: ["office"],
});
client.on("task.received", (payload) => {
console.log("Task Received", payload);
// Do something with the payload...
});
Constructors​
constructor​
• new Client(opts
)
Parameters​
Name | Type | Description |
---|---|---|
opts | Object | - |
opts.topics | string[] | SignalWire topics, e.g. ['home', 'office']. Previously known as "context" . |
opts.project | string | SignalWire project id, e.g. a10d8a9f-2166-4e82-56ff-118bc3a4840f . |
opts.token | string | SignalWire project token, e.g. PT9e5660c101cd140a1c93a0197640a369cf5f16975a0079c9 . |
opts.debug? | Object | - |
opts.debug.logWsTraffic? | boolean | If true , logs all WebSocket traffic. Default is false . |
Example​
const client = new Task.Client({
project: "<project-id>",
token: "<api-token>",
topics: ["office"],
});
Methods​
disconnect​
â–¸ disconnect(): void
Disconnects this client. The client will stop receiving events and you will need to create a new instance if you want to use it again.
Returns​
void
Example​
client.disconnect();
off​
â–¸ off(event
, fn?
)
Remove an event handler.
Parameters​
Name | Type | Description |
---|---|---|
event | string | Name of the event. See Events for the list of available events. |
fn? | Function | An event handler which had been previously attached. |
on​
â–¸ on(event
, fn
)
Attaches an event handler to the specified event.
Parameters​
Name | Type | Description |
---|---|---|
event | string | Name of the event. See Events for the list of available events. |
fn | Function | An event handler. |
Example​
In the below example, we are listening for the call.state
event and logging the current call state to the console.
This means this will be triggered every time the call state changes.
call.on("call.state", (call) => {
console.log("call state changed:", call.state);
});
once​
â–¸ once(event
, fn
)
Attaches an event handler to the specified event. The handler will fire only once.
Parameters​
Name | Type | Description |
---|---|---|
event | string | Name of the event. See Events for the list of available events. |
fn | Function | An event handler. |
removeAllListeners​
â–¸ removeAllListeners(event?
)
Detaches all event listeners for the specified event.
Parameters​
Name | Type | Description |
---|---|---|
event? | string | Name of the event (leave this undefined to detach listeners for all events). See Events for the list of available events. |
Events​
task.received​
• task.received(payload
)
Emitted whenever a task is received. Your event handler receives the payload. Example:
const client = new Task.Client(...)
client.on('task.received', (payload) => {
console.log('Task Received', payload)
// Do something with the payload...
})
Parameters​
Name | Type | Description |
---|---|---|
payload | Record<string, unknown> | The message payload. |