Configuration
Flex UI's configuration allows you to control the way the overall app loads, as well as the behavior of individual Flex Components. In the configuration object, you can define the default properties of your Flex Components. You can also configure properties that are not tied to specific Components.
Properties:
language?: string
language code, not used
logLevel?: "silent" | "error" | "warning" | "info" | "debug" | "trace"
level for logger
Default Value:
"error"
theme?: ThemeConfigProps
theme configuration
isLight?: boolean
- Represents whether light or dark theme should be usedtokens?: DeepPartial<Tokens>
- Paste tokens. For more on each token information, please refer to Twilio PastecomponentThemeOverrides?: Theme
- Object containing styles of the component which is to be overridden. See Theme Interface
sdkOptions?: SDKOptions
SDK options
worker?: WorkerOptions
- options to pass to TaskRouter Worker SDK. Seechat?: ConversationsOptions
- options to pass to Chat SDK. Seevoice?: VoiceOptions
- options to pass to Voice SDK. SeeacceptOptions?: Call.AcceptOptions
- options to be passed in call.accept(). SeeaudioConstraints?: MediaTrackConstraints
- options to be passed in device.audio.setAudioConstraints(). SeecodecPreferences?: Array<string>
- codec names to be passed in device.options.codecPreferences. These can optionally use theDevice.Codec
type values from@twilio/voice-sdk
.sounds?: Record<string, string>
- sounds names to be passed in device.options.sounds. These can optionally use theCall.Sounds
type values from@twilio/voice-sdk
for the object keys.insights?: object
- options to pass to Sync SDK. Seeflex?: DeepPartial<ClientOptions>
- to pass to Flex SDK.
sso?: SSOConfiguration
SSO configuration
accountSid?: string
- account SIDidpUrl?: string
- idpUrlloginPopup?: boolean
- whether to launch IdP login in a new windowDefault Value:
false
loginPopupFeatures?: string
- standard window.open() features param to be applied to popup windowproducts?: Array<string>
- array of productsredirectUrl?: string
- redirect url where to return back from identity provider to log in to FlexDefault Value:
window.location.href
tokenRefreshThresholdMs?: number
- token refresh threshold in ms
oauth?: OAuthConfiguration
OAuth2.0 configuration. Will only be available if account flag is on
pluginService?: PluginService
PluginService configuration
enabled?: boolean
- Whether the plugin service is enabled or not
componentProps?: object
Props to be set for React components. Key of the object is component name. e.g. { AgentDesktopView: { showPanel2: false } }
router?: object
Router configuration
type?: "browser" | "memory"
- type of the routerhistory?: object
- history object to use for routingisolate?: boolean
- whether to isolate Flex routing from other routing. Makes Flex to use memory router.
disableBrowserVoice?: boolean
whether to disable Twilio Voice SDK instantiation
initialDeviceCheck?: boolean
Whether to conduct an initial audio device check
rejectPendingReservations?: boolean
whether to reject all pending reservations if user goes to an offline activity
insights?: object
insights configuration object
enableClientCalling?: boolean
Whether to enable client calling
fileAttachment?: FileAttachmentConfig
File attachment configuration
enabled?: boolean
- Represents if file attachments are supported.Default Value:
true
numberOfAttachments?: number
- Maximum number of file attachments supported per message.Default Value:
1
maxFileSize?: number
- Maximum file size that can be uploaded. Enter a value in bytes. Default is 10mbDefault Value:
10485760
maxFileSizeTotal?: number
- Maximum total file attachments size that can be uploaded per message. Enter a value in bytes.acceptedExtensions?: Array<string>
- Allowed file extensions to be uploaded.Default Value:
["jpg", "jpeg", "png", "gif", "txt", "pdf"]
readOnly?: boolean
- Represents if file attachment is read onlyDefault Value:
false
holdMusicUrl?: string
url for audio file to play when call is on hold
holdMusicMethod?: string
holdMusicMethod
locations?: Array<LocationConfig>
array of LocationConfig objects
name: string
- region nameedge: Array<string> | string
- array of edge names or edge name
disableTelemetry?: boolean
whether to disable telemetry
enableReduxLogging?: boolean
whether to enable redux logging
markdown?: object
markdown configuration
notifications?: object
Notification configuration
outboundSettings?: OutboundConfig
Outbound configuration
email: object
- Configuration object for outbound emaildefaultAddress.address_metadata.from_name: string
- The sender namedefaultAddress.coordinates.address: string
- The senders email addressdefaultSettings.workflow_sid: string
- Sid of the workflow to use for task assignmentdefaultAddress.queue_sid: string
- Sid of the queue to use for task assignment
channelConfig?: Array<ChannelConfig>
array of channel configurations
addressType: string
- Channel typecbmAttachments: object
- Configuration object for cbm attachment settingsenabled: boolean
- Whether attachments are enablednumberOfAttachments: number
- Maximum number of attachments allowedmaxFileSize: number
- Maximum allowed file size in bytesmaxTotalFileSize: number
- Limit in bytes for the cumulative size of all attachmentsacceptedExtensions: Array<string>
- Array of allowed file extensions
flexUiStatusReport?: FlexUiStatusReport
configuration of UI display of status report
debuggerIntegration?: DebuggerIntegration
configuration of debugger integration
isEmailChannelEnabled?: boolean
whether email channel is enabled
citrixVoiceVdi?: citrixVoiceVdi
configuration of Enable Voice on Citrix VDI