TaskHelper
Helper functions for tasks
Example:
import { TaskHelper } from "@twilio/flex-ui";const taskHelper = new TaskHelper(someTask);
isLiveCall(task) => boolean#
Returns true if task is a live (accepted) call.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isLiveCall(someTask);
isCallOnHold(task) => boolean#
Returns true if call associated with a task is on hold.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
canKickWorkerParticipant(task, participant) => boolean#
Returns true if current worker can kick the worker participant in the live call task.
Parameters:
task: ITask
participant: ConferenceParticipant
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const canRemoveWorker = TaskHelper.canKickWorkerParticipant(someTask, participant);
canHold(task) => boolean#
Returns true if task is live call task and worker can hold this call task.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const canHoldCall = TaskHelper.canHold(someTask);
isCurrentWorkerOnHold(task) => boolean#
Returns true if task is conference call and worker is on hold.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isWorkerOnHold = TaskHelper.isCurrentWorkerOnHold(someTask);
canTransfer(task) => boolean#
Returns true if task is live call task and worker can transfer this call task.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const canTransferTask = TaskHelper.canTransfer(someTask);
isGroupCall(task) => boolean#
Returns true if task is Flex conference call with more than 2 participants.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isGroupCall = TaskHelper.isGroupCall(someTask);
isLiveChat(task) => boolean#
Returns true if task is a live (accepted) chat based.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isLiveChat = TaskHelper.isLiveChat(someTask);
isIncomingCall(task) => boolean#
Returns true if task is an incoming call.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isChatBasedTask(task) => boolean#
Returns true if task is a chat based.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isCallTask(task) => boolean#
Returns true if task is a call based task.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
getTaskConversationSid(task) => string#
Gets conversation sid for a task.
Parameters:
task: ITask
Returns:
string
Conversation sid.
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isPending(task) => boolean#
Returns if reservation associated with the task is in pending state.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isInWrapupMode(task) => boolean#
Returns if reservation associated with the task is in wrapping state.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isCompleted(task) => boolean#
Returns if reservation associated with the task is in completed state.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const busy = TaskHelper.isCallOnHold(someTask);
isTaskAssignedToCurrentWorker(task) => boolean#
Returns if reservation associated with the task is assigned to the current user.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isTaskAssignedToCurrentWorker = TaskHelper.isTaskAssignedToCurrentWorker(someTask);
getTaskFromConversationSid(conversationSid) => ITask#
Returns a task which is associated with provided chat channel sid.
Parameters:
conversationSid: string
Unique identifier of the conversation.
Returns:
ITask | undefined
Example:
import { TaskHelper } from "@twilio/flex-ui";const task = TaskHelper.getTaskFromConversationSid("CHXXXXXXXXXXXXXXXXX");
getTaskByTaskSid(reservationSid) => ITask#
Returns task by reservation sid.
Parameters:
reservationSid: string
Reservation sid.
Returns:
Example:
import { TaskHelper } from "@twilio/flex-ui";const task = TaskHelper.getTaskByTaskSid("WRXXXXXXXXXXXXXXXXX");
isTaskAccepted(task) => boolean#
Returns true if task is not pending.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isTaskAccepted = TaskHelper.isTaskAccepted(someTask);
isOutboundCallTask(task) => boolean#
Returns true if task is as outbound call task.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isOutboundCallTask = TaskHelper.isOutboundCallTask(someTask);
isInitialOutboundAttemptTask(task) => boolean#
Returns true if the task is initial pending attempt for outbound call.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isInitialOutboundAttemptTask = TaskHelper.isInitialOutboundAttemptTask(someTask);
isCBMTask(task) => boolean#
Returns true if task is a CBM task.
Parameters:
task: ITask
Returns:
boolean
Example:
import { TaskHelper } from "@twilio/flex-ui";const isCBMTask = TaskHelper.isCBMTask(someTask);
chat: ConversationHelper#
Gets the helper for associated chat channel.
Example:
import { TaskHelper } from "@twilio/flex-ui";const taskHelper = new TaskHelper(someTask);console.log(taskHelper.chat);
durationSinceUpdate: string#
Duration since last update of a task. Uses dateUpdated
property of a task.
Example:
import { TaskHelper } from "@twilio/flex-ui";const taskHelper = new TaskHelper(someTask);console.log(taskHelper.durationSinceUpdate);
durationSinceUpdateShort: string#
Duration since last update of a task in short format. Uses dateUpdated
property of a task.
Example:
import { TaskHelper } from "@twilio/flex-ui";const taskHelper = new TaskHelper(someTask);console.log(taskHelper.durationSinceUpdateShort);
jsonString: string#
Serializes task object to json string.
Example:
import { TaskHelper } from "@twilio/flex-ui";const taskHelper = new TaskHelper(someTask);console.log(taskHelper.jsonString);