Task.Client
Constructors
• new Client(opts)
Parameters
| Name | Type | Description |
|---|---|---|
opts | Object | - |
opts.contexts | string[] | SignalWire contexts, e.g. 'home', 'office'… |
opts.project | string | SignalWire project id, e.g. |
opts.token | string | SignalWire project token, e.g. |
Methods
▸ 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<T>(event, fn?): EmitterContract<TaskClientApiEvents>
Type parameters
| Name | Type |
|---|---|
T | extends "task.received" |
Parameters
| Name | Type |
|---|---|
event | T |
fn? | (...args: ArgumentMap<TaskClientApiEvents>[Extract<T, "task.received">]) => void |
Returns
EmitterContract<TaskClientApiEvents>
▸ on<T>(event, fn): EmitterContract<TaskClientApiEvents>
Type parameters
| Name | Type |
|---|---|
T | extends "task.received" |
Parameters
| Name | Type |
|---|---|
event | T |
fn | (...args: ArgumentMap<TaskClientApiEvents>[Extract<T, "task.received">]) => void |
Returns
EmitterContract<TaskClientApiEvents>
▸ once<T>(event, fn): EmitterContract<TaskClientApiEvents>
Type parameters
| Name | Type |
|---|---|
T | extends "task.received" |
Parameters
| Name | Type |
|---|---|
event | T |
fn | (...args: ArgumentMap<TaskClientApiEvents>[Extract<T, "task.received">]) => void |
Returns
EmitterContract<TaskClientApiEvents>
▸ removeAllListeners<T>(event?): EmitterContract<TaskClientApiEvents>
Type parameters
| Name | Type |
|---|---|
T | extends "task.received" |
Parameters
| Name | Type |
|---|---|
event? | T |
Returns
EmitterContract<TaskClientApiEvents>