TaskChannels
Task Channels Manager
getRegistered() => Array.<TaskChannelDefinition>#
Gets registered task channel definitions
Returns:
Array.<TaskChannelDefinition>Array of registered task channel definitions
Example:
import { TaskChannels } from "@twilio/flex-ui";TaskChannels.getRegistered();getForTask(task) => TaskChannelDefinition#
Gets task channel definition for a task
Parameters:
task: ITasktask
Returns:
TaskChannelDefinitionfirst matched task channel definition
Example:
import { TaskChannels } from "@twilio/flex-ui";TaskChannels.getForTask(taskObject);getForConversation(conversationSid) => TaskChannelDefinition#
Gets task channel definition for a conversation
Parameters:
conversationSid: stringtask
Returns:
TaskChannelDefinitionfirst matched task channel definition
Example:
import { TaskChannels } from "@twilio/flex-ui";TaskChannels.getForConversation(conversationSid);register(definition, mergeWithDefaultChannel?) => unknown#
Registers a task channel definition. Definition is prepended to previously registered ones
Parameters:
definition: TaskChannelDefinitiontask channel definition
mergeWithDefaultChannel?: booleanwhether 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) => unknown#
Unregisters previously registered task channel definition
Parameters:
definition: TaskChannelDefinitiontask 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);