Type Definitions
# AppConfiguration
Configuration interface
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
language |
string |
<optional> |
language code, not used | |
logLevel |
"silent" | "error" | "warning" | "info" | "debug" | "trace" |
<optional> |
"error" | level for logger |
colorTheme |
Configuration.ThemeConfigProps | Configuration.PredefinedThemeName |
<optional> |
color theme configuration | |
sdkOptions |
Configuration.SDKOptions |
<optional> |
SDK options | |
sso |
Configuration.SSOConfiguration |
<optional> |
SSO configuration | |
pluginService |
Configuration.PluginService |
<optional> |
PluginService configuration | |
componentProps |
Object |
<optional> |
Props to be set for React components. Key of the object is component name. e.g. { AgentDesktopView: { showPanel2: false } } | |
router |
Object |
<optional> |
Router configuration | |
type |
"browser" | "memory" |
<optional> |
type of the router | |
history |
Object |
<optional> |
history object to use for routing | |
isolate |
boolean |
<optional> |
whether to isolate Flex routing from other routing. Makes Flex to use memory router. | |
disableBrowserVoice |
boolean |
<optional> |
whether to disable Twilio Voice SDK instantiation | |
rejectPendingReservations |
boolean |
<optional> |
whether to reject all pending reservations if user goes to an offline activity | |
warmTransfers |
Object |
<optional> |
Warm transfer configuration | |
enabled |
boolean |
<optional> |
Whether to enable warm transfer feature | |
notifications |
Configuration.Notifications |
<optional> |
Notification configuration | |
fileAttachment |
Configuration.FileAttachmentConfig |
<optional> |
File attachment configuration |
# CustomPlugins
Custom plugins interface
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
phase |
number | plugin phase | |
name |
string | plugin name | |
src |
string | url where plugin can be found | |
version |
string |
<optional> |
plugin version |
# FileAttachmentConfig
File attachment configuration
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
maxFileSize |
number |
<optional> |
10485760 | Maximum file size that can be uploaded. Enter a value in bytes. Default is 10mb |
acceptedExtensions |
Array.<string> |
<optional> |
["jpg", "jpeg", "png", "gif", "txt", "pdf"] | Allowed file extensions to be uploaded. |
readOnly |
boolean |
<optional> |
false | Represents if file attachment is read only |
# Notifications
Notifications interface
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
browser |
boolean |
<optional> |
Whether browser notifications are enabled |
# PluginService
Plugin Service interface
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
enabled |
boolean |
<optional> |
Whether the plugin service is enabled or not |
# PluginServiceAttributes
Plugin service attributes interface
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
custom_plugins_url |
string |
<optional> |
url to the plugin JSON |
custom_plugins |
Configuration.CustomPlugins |
<optional> |
array of plugins |
# SDKOptions
Options for Twilio SDKs used by Flex
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
worker |
Object |
<optional> |
options to pass to TaskRouter Worker SDK. See https://twilio.github.io/twilio-taskrouter.js/Worker.html#Worker__anchor |
chat |
Object |
<optional> |
options to pass to Chat SDK. See http://media.twiliocdn.com/sdk/js/chat/releases/3.2.3/docs/Client.html#.create__anchor |
voice |
Object |
<optional> |
options to pass to Voice SDK. See https://www.twilio.com/docs/voice/client/javascript/device#constructor |
insights |
Object |
<optional> |
options to pass to Sync SDK. See https://media.twiliocdn.com/sdk/js/sync/releases/0.11.1/docs/Client.html#Client__anchor |
Object
# ServiceConfiguration
Service configuration
Properties:
| Name | Type | Description |
|---|---|---|
account_sid |
string | account SID |
chat_service_instance_sid |
string | chat service instance SID |
runtime_domain |
string | Twilio Runtime Domain |
taskrouter_workspace_sid |
string | Task Router Workspace SID for Flex |
taskrouter_target_taskqueue_sid |
string | Task Router Task Queue SID |
taskrouter_target_workflow_sid |
string | Task Router Workflow SID |
outbound_call_flows |
any | Outbound call flows |
taskrouter_skills |
Array.<Manager.SkillDefinition> | all possible skills that can be assigned |
# SkillDefinition
Skill definition
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
name |
string | name of the skill | |
multivalue |
boolean | whether skill may have a numerical level | |
minimum |
number |
<optional> |
maximum value for level |
maximum |
number |
<optional> |
minimum value for level |
Object
# SSOConfiguration
SSO Configuration interface
Properties:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
accountSid |
string |
<optional> |
account SID | |
loginPopup |
boolean |
<optional> |
false | whether to launch IdP login in a new window |
loginPopupFeatures |
string |
<optional> |
standard window.open() features param to be applied to popup window | |
redirectUrl |
string |
<optional> |
window.location.href | redirect url where to return back from identity provider to log in to Flex |
# ThemeConfigProps
Theme configuration
Properties:
| Name | Type | Attributes | Description |
|---|---|---|---|
baseName |
Config.PredefinedThemeName |
<optional> |
predefined theme name to take as base |
colors |
CoreThemeColors | BaseThemeColors |
<optional> |
color overrides to be applied |
light |
boolean |
<optional> |
whether theme is light or not |
theme |
Theme |
<optional> |
Overrides for the theme object |