Jump to: navigation, search
(Update with the copy of version: draft)
(Automated save: adding PEC_Migrated template.)
 
(5 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
= Configuration =
 
= Configuration =
−
== Description ==
 
−
Offers holds the configuration namespace '_genesys.widgets.offers' which contains UI options.
 
  
−
== Example ==
+
{{Template:PEC_Migrated}}
−
<pre>
 
−
window._genesys.widgets.offers = {
 
  
−
offers: {
 
−
 
−
mode: 'overlay',
 
−
layout: 'leftText',
 
−
title: 'Offer Title',
 
−
headline: 'This is the offer's headline',
 
−
body: 'This is the offer's body',
 
−
button: 'Accept Offer',
 
−
ctaURL: 'http://www.genesys.com',
 
−
video: 'https://www.youtube.com/watch?v=########',
 
−
timeout: 11000
 
−
},
 
−
 
−
downloadVideoLib: true
 
−
};
 
−
</pre>
 
−
 
−
== Options ==
 
−
{|
 
−
|-
 
−
! Name
 
−
! Type
 
−
! Description
 
−
! Accepted Values
 
−
! Default
 
−
! Required
 
−
|-
 
−
| offers.mode
 
−
| string
 
−
| Selects between overlay and toaster display modes.
 
−
| 'overlay', 'toaster'
 
−
| toaster
 
−
| false
 
−
|-
 
−
| offers.layout
 
−
| string
 
−
| For the 'overlay' display container, sets the text on the right or left side of the image/video.
 
−
| 'leftText', 'rightText'
 
−
| leftText
 
−
| false
 
−
|-
 
−
| offers.title
 
−
| string
 
−
| The title of the widget; sets the title text in the widget header.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.headline
 
−
| string
 
−
| A headline string displayed in larger text above the body.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.body
 
−
| string
 
−
| The main text body of the offer.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.button
 
−
| string
 
−
| A short string to be displayed inside the CTA button.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.ctaURL
 
−
| string
 
−
| A URL to open when the user clicks on the image or CTA button.
 
−
| n/a
 
−
| n/a
 
−
| true
 
−
|-
 
−
| offers.image
 
−
| string
 
−
| A URL of an image to be displayed in the offer.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.video
 
−
| string
 
−
| A URL of a YouTube or Vimeo video to be displayed in the offer. This will replace and image if an image URL is present. Warnings will be present in the JavaScript console if the video URL is not valid.
 
−
| n/a
 
−
| n/a
 
−
| false
 
−
|-
 
−
| offers.timeout
 
−
| integer
 
−
| Sets a timeout, in milliseconds, after which offers widget will close if there is no interaction.
 
−
| positive integers
 
−
| 15000
 
−
| false
 
−
|-
 
−
| downloadVideoLib
 
−
| boolean
 
−
| An option to enable loading of 3rd party video libraries. Needs to be set to true in order to show videos inside an offer. Note: this option is only available in the static config, passing this along with the open parameter will not work.
 
−
| true/false
 
−
| false
 
−
| n/a
 
−
|-
 
−
|}
 
  
 +
{{NoteFormat|Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Offers-combined#Configuration.}}
 
[[Category:V:PSAAS:Public]]
 
[[Category:V:PSAAS:Public]]

Latest revision as of 23:03, June 21, 2020

Configuration

Important
This content may not be the latest Genesys Engage cloud content. To find the latest content, go to Genesys Engage cloud for Administrators.


Important
Documentation for this software has moved to a new home. Please update links and bookmarks to content hosted at https://all.docs.genesys.com/WID/Current/SDK/Offers-combined#Configuration.
This page was last edited on June 21, 2020, at 23:03.
Comments or questions about this documentation? Contact us for support!