Methods
# getForTask(task) → {TaskChannelDefinition}
Gets task channel definition for a task
Parameters:
| Name | Type | Description |
|---|---|---|
task |
ITask | task |
first matched task channel definition
Example
import { TaskChannels } from "@twilio/flex-ui";
TaskChannels.getForTask(taskObject);# getRegistered() → {Array.<TaskChannelDefinition>}
Gets registered task channel definitions
Array.<TaskChannelDefinition>
Example
import { TaskChannels } from "@twilio/flex-ui";
TaskChannels.getRegistered();# register(definition, mergeWithDefaultChannelopt)
Registers a task channel definition. Definition is prepended to previously registered ones
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
definition |
TaskChannelDefinition | task channel definition | ||
mergeWithDefaultChannel |
boolean |
<optional> |
true | whether to merge unspecified defaults in |
Example
import { TaskChannels, DefaultTaskChannels } from "@twilio/flex-ui";
const testChannel = DefaultTaskChannels.createChatTaskChannel("testChannel", (task) => true);
TaskChannels.register(testChannel);# unregister(definition)
Unregisters previously registered task channel definition
Parameters:
| Name | Type | Description |
|---|---|---|
definition |
TaskChannelDefinition | task channel definition to unregister |
Example
import { TaskChannels, DefaultTaskChannels } from "@twilio/flex-ui";
const registeredChannels = TaskChannels.getRegistered();
const registeredTestChannel = registeredChannels[registeredChannels.length - 1];
TaskChannels.unregister(registeredTestChannel);