Class

Config

Config

Members

string

# apiUrl

The Glia API URL.
boolean

# enableVisitorTranscriptDownload

When true, visitor can download chat transcript after engagement has ended. When false, visitor does not have the option to download the transcript.
string

# engagementMode

During engagement client site can be wrapped into an element where CoBrowsing session is started with an operator. This configuration option tells whether the client browser should be wrapped into an iframe (`engagementMode == 'iframed'`) or not (`engagementMode == 'iframeless'`). When 'iframed' option is used, the engagement should be iframed using {Engagement#iframePage}.
Deprecated:
string

# externalButtonHtml

HTML for a Glia button (Deprecated).
boolean

# hideVisitorInfo

When true, the visitor name and email are displayed above chat during engagement. When false, the visitor name and email are not displayed.
boolean

# isCustomTheme

When true, a non-default theme is being used for the site. When false, reactiveTabVisuals is used for styling instead. Otherwise reactiveTabVisuals is ignored.
string

# locale

The locale of the application. This can be either a base or a custom locale. The format of the base locale is fixed and consists of the primary sub-code that identifies the language in ISO 639-1 format (e.g., "en") and an ISO 3166-2 sub-code capital letters that specify the national variety (e.g., "GB" or "US"). The format of the custom locale has no fixed structure, it can be any at least 7-digit string set by the user. The default locale is "en-US".
boolean

# offlineMessagesEnabled

When true, visitors are able to send offline messages to operators. When false, visitors are not be able to send offline messages.
string

# panelPosition

Shows on which side the Engagement panel should be positioned. When 'right', the Engagement panel is positioned to the right side of the web page. When 'left', the Engagement panel is positioned on the left side of the page.
boolean

# phoneExtensionEnabled

When true, the phone extension input is displayed together with the phone number input when choosing phone audio as engagement media. When false, the phone extension input is not displayed. Phone extension is an optional value containing commas and up to 7 digits. Maximum length is 25 characters. Used in Salemove#requestEngagement, Salemove#queueForEngagement, Salemove#setIncomingEngagementRequestHandler and MediaUpgradeOffer#select
string

# phoneNumberDefaultCountry

ISO 3166-1 alpha-2 country code (e.g. 'us' or 'uk') of the desired phone number default country. Used when displaying phone number input.
boolean

# queuingEnabled

When true, visitors can queue for engagements.
See:
boolean

# reactiveTabEnabled

When true, the Reactive tab is enabled. When false, the Reactive tab is disabled.
ReactiveTabVisuals

# reactiveTabVisuals

Visual configuration of the Reactive tab as a ReactiveTabVisuals instance.
boolean

# showReactiveTabWhenOperatorsUnavailable

When true, visitors see the Reactive tab even when there are no operators available. When false, visitors cannot see the Reactive tab without available operators.
SiteLogo
Logo configuration for this site (SiteLogo).
string

# theme

Either a URL to a custom theme's CSS or an empty string. When an empty string, reactiveTabVisuals should be used for styling instead. Otherwise reactiveTabVisuals should be ignored.
Deprecated:
string

# visitorPageAdaption

During engagement client site is adapted when CoBrowsing session is started with an operator. This configuration option tells whether the client browser should be wrapped into an iframe (`visitorPageAdaption == 'iframe'`), a div (`visitorPageAdaption == 'div'`) or adapted with CSS (`visitorPageAdaption == 'style'`).
boolean

# widgetMode

When true, the views shown to visitor during engagement are draggable around the page. When false, the views should be fixed in place.