TaskChannelDefinition
Interface to define a task channel for Flex
Properties:
name: stringname of the task channel definition
isApplicable: (task) => booleanCallback to determine whether this task channel is applicable for a given task.
task: ITask- task to evaluate applicability forboolean- true if task channel is applicable for given task
capabilities: Set<TaskChannelCapability>capabilities of task channel
charLimit: numbermessage character limit for task channel with chat capabilities
colors?: objectcolors to be used
main?: TaskStatusBasedType- main color code as string to use in TaskList, TaskCard, Canvases
sounds?: TaskChannelDefinition.TaskSoundssounds to be used for specific tasks
icons?: objecticons to render for the task channel
list?: TaskStatusBasedType- list icon to be used in TaskList and TaskCardListmain?: TaskStatusBasedType- icon to be used in Tab headers if tab is not selectedactive?: TaskStatusBasedType- icon to be used in Tab headers if tab is selected and in Task Canvases as the main icon
templates?: objecttemplate strings for components
IncomingTaskCanvas?: object- templates for IncomingTaskCanvasfirstLine?: TaskStatusBasedType- first linesecondLine?: TaskStatusBasedType- second lineCallCanvas?: object- templates for CallCanvasfirstLine?: TaskStatusBasedType- first linesecondLine?: TaskStatusBasedType- second lineTaskListItem?: object- templates for TaskListItemfirstLine?: TaskStatusBasedType- first linesecondLine?: TaskStatusBasedType- second lineextraInfo?: TaskStatusBasedType- extra info to be shownTaskCanvasHeader?: object- templates for TaskCanvasHeadertitle?: TaskStatusBasedType- titleendButton?: TaskStatusBasedType- end button textTaskCard?: object- templates for TaskCardfirstLine?: TaskStatusBasedType- first linesecondLine?: TaskStatusBasedType- second lineTaskInfoPanel?: object- templates for TaskInfoPanelcontent?: TaskStatusBasedType- content of the panelSupervisor?: object- templates for components for supervisorsTaskCanvasHeader?: object- templates for Supervisor.TaskCanvasHeadertitle?: TaskStatusBasedType- titleendButton?: TaskStatusBasedType- end button textTaskInfoPanel?: object- templates for Supervisor.TaskInfoPanelcontent?: TaskStatusBasedType- content of the panelTaskOverviewCanvas?: object- templates for Supervisor.TaskOverviewCanvasfirstLine?: TaskStatusBasedType- first linesecondLine?: TaskStatusBasedType- second line
addedComponents?: Array<TaskChannelComponentRegistration>components to be added for task channel
target: string- of a Flex component. Component must have static "Content" property.component: React.ReactChild- component to registeroptions: ContentFragmentProps- properties for component registration
replacedComponents?: Array<TaskChannelComponentRegistration>components to be replaced for task channel
target: string- of a Flex component. Component must have static "Content" property.component: React.ReactChild- component to registeroptions: ContentFragmentProps- properties for component registration
removedComponents?: Array<TaskChannelComponentRemoveRequest>component removal request for task channel
target: string- of a Flex component. Component must have static "Content" property.key: string- key of a component to removeoptions: ContentFragmentProps- properties for component removal.
componentProps: objectObject of task-channel specific components props
notifications?: TaskChannelNotificationOptionsNotification properties
override: NotificationOverride- Map of notification overrides
exports.TaskChannelCapability: "Info" | "Call" | "Chat" | "Video" | "Wrapup"#
Task channel capabilities
Properties:
"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
exports.ReservationStatuses: "Accepted" | "Wrapping" | "Completed" | "Canceled" | "Pending" | "Rescinded"#
ReservationStatuses
Properties:
Wrapping: "Wrapping"wrapping state
Completed: "Completed"completed state
Canceled: "Canceled"canceled state
Pending: "Pending"pending state
Accepted: "Accepted"accepted state
Rescinded: "Rescinded"rescinded state