Members
# static exports.ClientManagerInstance
Enum holding the list of Flex Clients to be used by the ClientManagerHelpers
Properties:
| Name | Type | Description |
|---|---|---|
FlexSDKClient |
"FlexSDKClient" | Flex SDK Client |
TaskRouterClient |
"TaskRouterClient" | TaskRouter Client |
ChatClient |
"ChatClient" | Chat Client |
VoiceClient |
"VoiceClient" | Voice Client |
InsightsClient |
"InsightsClient" | Insights Client |
PluginManager |
"PluginManager" | Plugin Manager |
FlexFeatures |
"FlexFeatures" | Flex Features |
Methods
# static forceDegraded(client, statusopt) → {Promise.<void>}
Force a Flex Client to work in a degraded mode
Flex clients must be set degraded before the UI initialises
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
client |
ClientManagerInstance | The Flex Client instance | ||
status |
boolean |
<optional> |
true | The degraded mode status. When set to `false`, it will cause Flex ro re-load. |
Promise.<void>
Example
import { ClientManagerHelpers, ClientManagerInstance } from "@twilio/flex-ui";
ClientManagerHelpers.forceDegraded(ClientManagerInstance.VoiceClient);# static isForcedDegraded(client) → {boolean}
Return the force degraded status for a given Flex Client
Parameters:
| Name | Type | Description |
|---|---|---|
client |
ClientManagerInstance | The Flex Client instance |
Check if the client is forced degraded
boolean
Example
import { ClientManagerHelpers, ClientManagerInstance } from "@twilio/flex-ui";
ClientManagerHelpers.isForcedDegraded(ClientManagerInstance.VoiceClient);