Jump to: navigation, search
(Created target blank page For Version: PSAAS:Public)
 
(Update with the copy of version: draft)
Line 1: Line 1:
−
<!-- Creation of the target page -->
+
= Configuration =
 +
 
 +
== Description ==
 +
SendMessage and SendMessageService share the configuration namespace '_genesys.widgets.sendmessage'. SendMessage has UI options while SendMessageService has connection options.
 +
== Example ==
 +
<pre>
 +
window._genesys.widgets.sendmessage = {
 +
 
 +
apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
 +
dataURL: 'http://10.0.0.121:7777/genesys/2/email',
 +
 
 +
SendMessageButton: {
 +
 
 +
enabled: true,
 +
template: '<div>Email</div>',
 +
effect: 'fade',
 +
openDelay: 1000,
 +
effectDuration: 300
 +
}
 +
};
 +
</pre>
 +
== Options ==
 +
{|
 +
|-
 +
! Name
 +
! Type
 +
! Description
 +
! Default
 +
! Required
 +
|-
 +
| formValidation
 +
| boolean
 +
| Enable/Disable browser form validations.
 +
| true
 +
| n/a
 +
|-
 +
| uploadsEnabled
 +
| boolean
 +
| Show/Hide the Attach Files link in the UI, will be shown if the value is set to true. This enables or disables the file upload feature.
 +
| true
 +
| n/a
 +
|-
 +
| SendMessageButton.enabled
 +
| boolean
 +
| Enable/Disable Send Message button on screen.
 +
 
 +
 
 +
Note: In case of running Widgets in lazy load mode, this option requires SendMessage plugin to be [[AppConfiguration#Options|pre-loaded]].
 +
| false
 +
| n/a
 +
|-
 +
| SendMessageButton.template
 +
| string
 +
| Custom HTML string template for Send Message button
 +
| <source lang='java'><div class='cx-widget cx-send-message-button' data-message='SendMessageButton'><span class='cx-icon cx-email-button-img cx-img-map preset-blue px24 email'></span><span class='i18n cx-email-button-label' data-message='SendMessageButton'></span></div></source>
 +
| n/a
 +
|-
 +
| SendMessageButton.effect
 +
| string
 +
| Type of animation effect when revealing Send Message button ('slide' or 'fade').
 +
| fade
 +
| n/a
 +
|-
 +
| SendMessageButton.openDelay
 +
| number
 +
| Number of milliseconds before displaying send message button on screen.
 +
| 1000
 +
| n/a
 +
|-
 +
| SendMessageButton.effectDuration
 +
| number
 +
| Length of animation effect in milliseconds.
 +
| 300
 +
| n/a
 +
|-
 +
|}
 +
 
 +
[[Category:V:PSAAS:Public]]

Revision as of 17:12, July 27, 2018

Configuration

Description

SendMessage and SendMessageService share the configuration namespace '_genesys.widgets.sendmessage'. SendMessage has UI options while SendMessageService has connection options.

Example

window._genesys.widgets.sendmessage = {

	apikey: 'n3eNkgLLgLKXREBMYjGm6lygOHHOK8VA',
	dataURL: 'http://10.0.0.121:7777/genesys/2/email',

	SendMessageButton: {

		enabled: true,
		template: '<div>Email</div>',
		effect: 'fade',
		openDelay: 1000,
		effectDuration: 300
	}
};

Options

Name Type Description Default Required
formValidation boolean Enable/Disable browser form validations. true n/a
uploadsEnabled boolean Show/Hide the Attach Files link in the UI, will be shown if the value is set to true. This enables or disables the file upload feature. true n/a
SendMessageButton.enabled boolean Enable/Disable Send Message button on screen. 


Note: In case of running Widgets in lazy load mode, this option requires SendMessage plugin to be pre-loaded.
false n/a
SendMessageButton.template string Custom HTML string template for Send Message button 
<div class='cx-widget cx-send-message-button' data-message='SendMessageButton'><span class='cx-icon cx-email-button-img cx-img-map preset-blue px24 email'></span><span class='i18n cx-email-button-label' data-message='SendMessageButton'></span></div>
 n/a
SendMessageButton.effect string Type of animation effect when revealing Send Message button ('slide' or 'fade'). fade n/a
SendMessageButton.openDelay number Number of milliseconds before displaying send message button on screen. 1000 n/a
SendMessageButton.effectDuration number Length of animation effect in milliseconds. 300 n/a
Comments or questions about this documentation? Contact us for support!