(Update with the copy of version: 8.5.0) |
(Update with the copy of version: draft) |
||
| Line 24: | Line 24: | ||
enabled: true, | enabled: true, | ||
| − | template: | + | template: <div class='cx-icon' data-icon='chat'></div>, |
effect: 'fade', | effect: 'fade', | ||
openDelay: 1000, | openDelay: 1000, | ||
| Line 32: | Line 32: | ||
}; | }; | ||
</pre> | </pre> | ||
| − | |||
== Options == | == Options == | ||
{| | {| | ||
| Line 44: | Line 43: | ||
| emojis | | emojis | ||
| boolean | | boolean | ||
| − | | Enable/disable Emoji menu inside chat message input | + | | Enable/disable Emoji menu inside chat message input. |
| true | | true | ||
| + | | | ||
| + | |- | ||
| + | | uploadsEnabled | ||
| + | | boolean | ||
| + | | Show/Hide the Send File button. The button will be shown if the value is set to true. | ||
| + | | false | ||
| | | | ||
|- | |- | ||
| Line 52: | Line 57: | ||
| Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form. | | Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form. | ||
| true | | true | ||
| + | | | ||
| + | |- | ||
| + | | timeFormat | ||
| + | | number/string | ||
| + | | This sets the time format for the timestamps in this widget. It can be 12 or 24. | ||
| + | | 12 | ||
| | | | ||
|- | |- | ||
| actionsMenu | | actionsMenu | ||
| boolean | | boolean | ||
| − | | Enable/disable actions menu next to chat message input | + | | Enable/disable actions menu next to chat message input. |
| true | | true | ||
| | | | ||
| Line 62: | Line 73: | ||
| autoInvite.enabled | | autoInvite.enabled | ||
| boolean | | boolean | ||
| − | | Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time | + | | Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time. |
| false | | false | ||
| | | | ||
| Line 87: | Line 98: | ||
| string | | string | ||
| Custom HTML string template for chat button. | | Custom HTML string template for chat button. | ||
| − | | <source lang='java'><div class= | + | | <source lang='java'><div class="cx-widget cx-webchat-chat-button cx-side-button" data-message="ChatButton" data-gcb-service-node="true"><span class="cx-icon" data-icon='chat'></span><span class="i18n cx-chat-button-label" data-message="ChatButton" tabindex="0"></span></div></source> |
| | | | ||
|- | |- | ||
| Line 115: | Line 126: | ||
|- | |- | ||
|} | |} | ||
| + | |||
[[Category:V:PSAAS:Public]] | [[Category:V:PSAAS:Public]] | ||
Revision as of 19:48, September 18, 2017
Configuration
Description
WebChat and WebChatService share the configuration namespace '_genesys.widgets.webchat'. WebChat has UI options while WebChatService has connection options.
Example
window._genesys.widgets.webchat = {
apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
dataURL: 'https://api.genesyscloud.com/gms-chat/2/chat',
userData: {},
emojis: true,
uploadsEnabled: false,
confirmFormCloseEnabled: true,
actionsMenu: true,
autoInvite: {
enabled: false,
timeToInviteSeconds: 10,
inviteTimeoutSeconds: 30
},
chatButton: {
enabled: true,
template: <div class='cx-icon' data-icon='chat'></div>,
effect: 'fade',
openDelay: 1000,
effectDuration: 300,
hideDuringInvite: true
}
};
Options
| Name | Type | Description | Default | Required |
|---|---|---|---|---|
| emojis | boolean | Enable/disable Emoji menu inside chat message input. | true | |
| uploadsEnabled | boolean | Show/Hide the Send File button. The button will be shown if the value is set to true. | false | |
| confirmFormCloseEnabled | boolean | Enable or disable displaying a confirmation message before closing WebChat if information has been entered into the registration form. | true | |
| timeFormat | number/string | This sets the time format for the timestamps in this widget. It can be 12 or 24. | 12 | |
| actionsMenu | boolean | Enable/disable actions menu next to chat message input. | true | |
| autoInvite.enabled | boolean | Enable/disable auto-invite feature. Automatically invites user to chat after user idles on page for preset time. | false | |
| autoInvite.timeToInviteSeconds | number | Number of seconds of idle time before inviting customer to chat. | 5 | |
| autoInvite.inviteTimeoutSeconds | number | Number of seconds to wait, after showing invite, before closing chat invite. | 30 | |
| chatButton.enabled | boolean | Enable/disable chat button on screen. | false | |
| chatButton.template | string | Custom HTML string template for chat button. | <div class="cx-widget cx-webchat-chat-button cx-side-button" data-message="ChatButton" data-gcb-service-node="true"><span class="cx-icon" data-icon='chat'></span><span class="i18n cx-chat-button-label" data-message="ChatButton" tabindex="0"></span></div> |
|
| chatButton.effect | string | Type of animation effect when revealing chat button. 'slide' or 'fade'. | fade | |
| chatButton.openDelay | number | Number of milliseconds before displaying chat button on screen. | 1000 | |
| chatButton.effectDuration | number | Length of animation effect in milliseconds | 300 | |
| chatButton.hideDuringInvite | boolean | When auto-invite feature is activated, hide the chat button. When invite is dismissed, reveal the chat button again. | true |
Comments or questions about this documentation? Contact us for support!