Description of icon
Flex UI
API Reference

Flex Events

Events emitted by the Flex Manager

viewResized#

View resized

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("viewResized", () => {});

flexSplitterResize#

Flex splitter resized

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("flexSplitterResize", () => {});

userLoggedIn#

User logged in. Fired during @see {Manager} creation

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("userLoggedIn", () => {});

selectedViewChanged#

Selected view changed

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("selectedViewChanged", (viewName) => {});

tokenUpdated#

Token updated

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("tokenUpdated", (tokenPayload) => {});

tokenExpired#

Token expired

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("tokenExpired", () => {});

pluginsLoaded#

All plugins are loaded

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("pluginsLoaded", () => {});

pluginsInitialized#

All plugins are initialized

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("pluginsInitialized", () => {});

chatChannelJoining#

Report issues on chat channel joining for agent

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("chatChannelJoining", () => {});

connectionStateChanged#

Connection status is changed

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("connectionStateChanged", () => {});

error#

Generic error has been thrown

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("flexError", () => {});

sessionValidated#

Emitted when SingleSessionGuard validate current Flex session

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("sessionValidated", () => {});

sessionInvalidated#

Emitted when a SDK clients get shut down

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("sessionInvalidated", () => {});

taskReceived#

Emitted when a worker receives a new task

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskReceived", (task: ITask) => {});

workerActivityUpdated#

Emitted when the worker's activity changes

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("workerActivityUpdated", (activity: Activity, allActivities: Map<string, Activity>) => {});

workerAttributesUpdated#

Emitted when the worker's attributes changes

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("workerAttributesUpdated", (newAttributes: Record<string, any>) => {});

taskUpdated#

Emitted when the worker's task status gets updated

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskUpdated", (task:ITask) => {});

taskAccepted#

Emitted when the worker's task gets set to 'accepted'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskAccepted", (task:ITask) => {});

taskCanceled#

Emitted when the worker's task gets set to 'canceled'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskCanceled", (task:ITask) => {});

taskCompleted#

Emitted when the worker's task gets set to 'completed'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskCompleted", (task:ITask) => {});

taskRejected#

Emitted when the worker's task gets set to 'rejected'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskRejected", (task:ITask) => {});

taskRescinded#

Emitted when the worker's task gets set to 'rescinded'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskRescinded", (task:ITask) => {});

taskTimeout#

Emitted when the worker's task gets set to 'timeout'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskTimeout", (task:ITask) => {});

taskWrapup#

Emitted when the worker's task gets set to 'wrapup'

Example:

import { Manager } from "@twilio/flex-ui";
const manager = Manager.getInstance();
manager.events.addListener("taskWrapup", (task:ITask) => {});
Rate this page

Need some help?

We all do sometimes; code is hard. Get help now from our support team, or lean on the wisdom of the crowd by visiting Twilio's Stack Overflow Collective or browsing the Twilio tag on Stack Overflow.