StateHelper
Helper class for state.
getCurrentPhoneCallState() => Call#
Get current call state if one exists.
Returns:
Call | undefinedIf it does not exist.
Example:
import { StateHelper } from "@twilio/flex-ui";const activeCall = StateHelper.getCurrentPhoneCallState();getConversationStateForTask(task) => ConversationState.ConversationState#
Gets current chat channel state for a task.
Parameters:
task: ITaskTask.
Returns:
ConversationState.ConversationState | undefinedChat channel state.
Example:
import { StateHelper } from "@twilio/flex-ui";const conversation = StateHelper.getConversationStateForTask(myConversationTask);getReservation(reservationSid) => Reservation#
Gets TaskRouter Reservation object.
Parameters:
reservationSid: stringReservation sid to retrieve.
Returns:
ReservationReservation instance.
Example:
import { StateHelper } from "@twilio/flex-ui";const reservation = StateHelper.getReservation("WRXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX");hasPendingCall() => boolean#
Returns true if user has a pending call reservation.
Returns:
booleanIf user has a pending call reservation.
Example:
import { StateHelper } from "@twilio/flex-ui";const isCallWaiting = StateHelper.hasPendingCall();Rate this page