Interface

TaskChannelDefinition

TaskChannelDefinition

Interface to define a task channel for Flex
Properties:
Name Type Attributes Description
name string name of the task channel definition
isApplicable TaskChannelDefinition.TaskChannelApplicableCb Callback to determine whether this task channel is applicable for a given task.
capabilities Set.<TaskChannelDefinition.TaskChannelCapability> capabilities of task channel
charLimit number message character limit for task channel with chat capabilities
colors object <optional>
 colors to be used
main TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 main color code as string to use in TaskList, TaskCard, Canvases
sounds TaskChannelDefinition.TaskSounds <optional>
 sounds to be used for specific tasks
icons object <optional>
 icons to render for the task channel
list TaskChannelDefinition.TaskStatusBasedType.<(string|React.ReactNode)> <optional>
 list icon to be used in TaskList and TaskCardList
main TaskChannelDefinition.TaskStatusBasedType.<(string|React.ReactNode)> <optional>
 icon to be used in Tab headers if tab is not selected
active TaskChannelDefinition.TaskStatusBasedType.<(string|React.ReactNode)> <optional>
 icon to be used in Tab headers if tab is selected and in Task Canvases as the main icon
templates object <optional>
 template strings for components
IncomingTaskCanvas object <optional>
 templates for IncomingTaskCanvas
IncomingTaskCanvas.firstLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 first line
IncomingTaskCanvas.secondLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 second line
CallCanvas object <optional>
 templates for CallCanvas
CallCanvas.firstLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 first line
CallCanvas.secondLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 second line
TaskListItem object <optional>
 templates for TaskListItem
TaskListItem.firstLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 first line
TaskListItem.secondLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 second line
TaskListItem.extraInfo TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 extra info to be shown
TaskCanvasHeader object <optional>
 templates for TaskCanvasHeader
TaskCanvasHeader.title TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 title
TaskCanvasHeader.endButton TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 end button text
TaskCard object <optional>
 templates for TaskCard
TaskCard.firstLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 first line
TaskCard.secondLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 second line
TaskInfoPanel object <optional>
 templates for TaskInfoPanel
TaskInfoPanel.content TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 content of the panel
Supervisor object <optional>
 templates for components for supervisors
Supervisor.TaskCanvasHeader object <optional>
 templates for Supervisor.TaskCanvasHeader
Supervisor.TaskCanvasHeader.title TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 title
Supervisor.TaskCanvasHeader.endButton TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 end button text
Supervisor.TaskInfoPanel object <optional>
 templates for Supervisor.TaskInfoPanel
Supervisor.TaskInfoPanel.content TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 content of the panel
Supervisor.TaskOverviewCanvas object <optional>
 templates for Supervisor.TaskOverviewCanvas
Supervisor.TaskOverviewCanvas.firstLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 first line
Supervisor.TaskOverviewCanvas.secondLine TaskChannelDefinition.TaskStatusBasedType.<string> <optional>
 second line
addedComponents Array.<TaskChannelDefinition.TaskChannelComponentRegistration> <optional>
 components to be added for task channel
replacedComponents Array.<TaskChannelDefinition.TaskChannelComponentRegistration> <optional>
 components to be replaced for task channel
removedComponents Array.<TaskChannelDefinition.TaskChannelComponentRemoveRequest> <optional>
 component removal request for task channel
componentProps Object Object of task-channel specific components props
notifications TaskChannelDefinition.TaskChannelNotificationOptions <optional>
 Notification properties

Members

"Accepted" | "Wrapping" | "Completed" | "Canceled" | "Pending" | "Rescinded"

# static exports.ReservationStatuses

ReservationStatuses
Properties:
Name Type Description
Wrapping "Wrapping" wrapping state
Completed "Completed" completed state
Canceled "Canceled" canceled state
Pending "Pending" pending state
Accepted "Accepted" accepted state
Rescinded "Rescinded" rescinded state
"Info" | "Call" | "Chat" | "Video" | "Wrapup"

# static exports.TaskChannelCapability

Task channel capabilities
Properties:
Name Type Description
"Info" "Info" whether channel has info panel
"Call" "Call" whether channel has call canvas capabilities
"Chat" "Chat" whether channel has chat canvas capabilities
"Video" "Video" whether channel has video calling capabilities
"Wrapup" "Wrapup" whether channel needs to go to Wrapup state before can be completed

Type Definitions

Partial.<Notification> | NotificationEventListener | null

# NotificationOverride

Notification override

# TaskCallbackType(task, componentType, argsopt) → {T}

Callback to provide values for Flex. Called from various areas of Flex.
Parameters:
Name Type Attributes Description
task ITask task
componentType React.ComponentType caller component type. One of Flex React components.
args Array.<Any> <optional>
 optional arguments
value to be used
T

# TaskChannelApplicableCb(task) → {boolean}

Parameters:
Name Type Description
task ITask task to evaluate applicability for
true if task channel is applicable for given task
boolean
Object

# TaskChannelComponentRegistration

Properties:
Name Type Description
target string of a Flex component. Component must have static "Content" property.
component React.ReactChild component to register
options ContentFragmentProps properties for component registration
Object

# TaskChannelComponentRemoveRequest

Properties:
Name Type Description
target string of a Flex component. Component must have static "Content" property.
key string key of a component to remove
options ContentFragmentProps properties for component removal.

# TaskChannelNotificationOptions

Properties:
Name Type Description
override TaskChannelDefinition.NotificationOverride

# TaskChannelNotificationOverrides

Notification overrides matched to notification ids.
Properties:
Name Type Attributes Description
NotificationId TaskChannelDefinition.NotificationOverride <optional>
 overrides for NotificationId
TaskChannelDefinition.TaskStatusBasedTypeBase

# TaskSounds

T | TaskChannelDefinition.TaskCallbackType | TaskChannelDefinition.TaskStatusBasedTypeBase

# TaskStatusBasedType

Valid types to use to define value for a task in given status
Object.<T>

# TaskStatusBasedTypeBase