ClientManagerHelpers
Flex Client Manager Helpers. Set of helpers to control Flex degraded mode behaviours.
forceDegraded(client, status?) => Promise<void>#
Force a Flex Client to work in a degraded mode Flex clients must be set degraded before the UI initialises
Parameters:
client: ClientManagerInstanceThe Flex Client instance
status?: booleanThe degraded mode status. When set to
false, it will cause Flex ro re-load.
Returns:
Promise<void>
Example:
import { ClientManagerHelpers, ClientManagerInstance } from "@twilio/flex-ui";ClientManagerHelpers.forceDegraded(ClientManagerInstance.VoiceClient);isForcedDegraded(client) => boolean#
Return the force degraded status for a given Flex Client
Parameters:
client: ClientManagerInstanceThe Flex Client instance
Returns:
booleanCheck if the client is forced degraded
Example:
import { ClientManagerHelpers, ClientManagerInstance } from "@twilio/flex-ui";ClientManagerHelpers.isForcedDegraded(ClientManagerInstance.VoiceClient);exports.ClientManagerInstance#
Enum holding the list of Flex Clients to be used by the ClientManagerHelpers
Properties:
FlexSDKClient: "FlexSDKClient"Flex SDK Client
TaskRouterClient: "TaskRouterClient"TaskRouter Client
ConversationsClient: "ConversationsClient"Conversations Client
VoiceClient: "VoiceClient"Voice Client
InsightsClient: "InsightsClient"Insights Client
PluginManager: "PluginManager"Plugin Manager
FlexFeatures: "FlexFeatures"Flex Features
Rate this page