WID/Current/SDK/App-combined - Revision history

WikiSysop at 11:00, June 17, 2022

2022-06-17T11:00:56Z

Chrissy.forrest@genesys.com: Published

2021-02-03T20:56:39Z

Published

Show changes

Chrissyforrest: Published

2020-10-27T18:51:59Z

Published

Chrissyforrest: Published

2020-07-30T20:43:27Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:36:58Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:51:28Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

2020-06-17T15:04:56Z

Published

Chrissyforrest: Published

2020-06-08T17:44:13Z

Published

Chrissyforrest: Published

2020-05-22T14:45:26Z

Published

Show changes

Chrissyforrest: Published

2020-04-09T21:46:37Z

Published

@@ Line 44: / Line 44: @@
 		mobileModeBreakpoint: 600,
 		debug: true,
 		header: {'Authorization': 'value'},
 		cookieOptions: {
@@ Line 107: / Line 109: @@
 {{!}}{{AnchorDiv|MP}}main.preload
 {{!}}array
-{{!}}(For use with lazy loading only) A list of plugins you want pre-loaded at startup. You may want certain plugins, such as SideBar, to be shown on screen as soon as possible; to do so, you may add 'sidebar' to this preload plugins array so it will be loaded after Widgets starts up. The names you add to the list must match the first part of the plugin filename you wish to load. Example: sidebar will load '''sidebar.min.js''' from the '''plugins/''' folder. All filenames are lowercase.{{NoteFormat|This preload array is intended for use when running widgets in lazy loading mode. You may also use this to pre-load your own custom-made plugins.|}}
+{{!}}'''Note''': For use with lazy loading only. A list of plugins you want pre-loaded at startup. You may want certain plugins, such as SideBar, to be shown on screen as soon as possible; to do so, you may add 'sidebar' to this preload plugins array so it will be loaded after Widgets starts up. The names you add to the list must match the first part of the plugin filename you wish to load. Example: sidebar will load '''sidebar.min.js''' from the '''plugins/''' folder. All filenames are lowercase.{{NoteFormat|This preload array is intended for use when running widgets in lazy loading mode. You may also use this to pre-load your own custom-made plugins.|}}
 {{!}}none
 {{!}}When lazy loading Widgets
@@ Line 150: / Line 152: @@
 {{!}}main.downloadGoogleFont
 {{!}}boolean
-{{!}} By default, Genesys Widgets downloads and uses the Google font Roboto. To disable this download, set value <code>false</code>.{{!}}<code>true</code>
+{{!}}By default, Genesys Widgets downloads and uses the Google font Roboto. To disable this download, set value <code>false</code>.
 {{!}}n/a
 {{!}}
 {{!}}-
 {{!}}main.deploymentID

@@ Line 105: / Line 105: @@
 {{!}}9.0.002.06
 {{!}}-
-{{!}}main.preload
+{{!}}{{AnchorDiv|MP}}main.preload
 {{!}}array
 {{!}}(For use with lazy loading only) A list of plugins you want pre-loaded at startup. You may want certain plugins, such as SideBar, to be shown on screen as soon as possible; to do so, you may add 'sidebar' to this preload plugins array so it will be loaded after Widgets starts up. The names you add to the list must match the first part of the plugin filename you wish to load. Example: 'sidebar' will load 'sidebar.min.js' from the 'plugins/' folder. All filenames are lowercase.{{NoteFormat|This preload array is intended for use when running widgets in lazy loading mode. You may also use this to pre-load your own custom-made plugins.|}}
@@ Line 195: / Line 195: @@
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
@@ Line 528: / Line 528: @@
 ===registerAutoLoad===
-(For use with lazy loading only) Allows you to register a plugin into the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=App-combined#Options|display text= preload plugins array}} so that it can be pre-loaded at the startup rather than lazy loading later. This can be useful when there is an active session maintained by your Widget and you would like to show it immediately at startup during page refresh or navigating across pages.
+(For use with lazy loading only) Allows you to register a plugin into the {{Link-SomewhereInThisVersion|manual=SDK|topic=App-combined|anchor=MP|display text=preload plugins array}} so that it can be pre-loaded at the startup rather than lazy loading later. This can be useful when there is an active session maintained by your Widget and you would like to show it immediately at startup during page refresh or navigating across pages.
 <source lang="javascript">Note: This command is intended for use when running widgets in lazy loading mode.
 You may also use this to register and pre-load your own custom-made plugins.</source>
@@ Line 559: / Line 559: @@
 ===deregisterAutoLoad===
-(For use with lazy loading only) Allows you to de-register a plugin from the {{Link-AnywhereElse|product=WID|version=Current|manual=SDK|topic=App-combined#Options|display text= preload plugins array}} so that it will not be pre-loaded at startup. This can be useful when there is no more active session maintained by your Widget and you don't want to show it on the screen immediately at startup.
+(For use with lazy loading only) Allows you to de-register a plugin from the {{Link-SomewhereInThisVersion|manual=SDK|topic=App-combined|anchor=MP|display text=preload plugins array}} so that it will not be pre-loaded at startup. This can be useful when there is no more active session maintained by your Widget and you don't want to show it on the screen immediately at startup.
 <source lang="javascript">Note: This command is intended for use when running widgets in lazy loading mode.
 You may also use this to de-register your own custom-made plugins.</source>
@@ Line 595: / Line 595: @@
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
-{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|anchor=top|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
+{{NoteFormat|The global bus object is a debugging tool. When implementing Widgets on your own site, do not use the global bus object to register your custom plugins. Instead, see {{Link-SomewhereInThisManual|topic=GWCBusExtensions|display text=Widgets Extensions}} for more information about extending Genesys Widgets.|1}}

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
 |alignment=Vertical
 |structuredtext=App is the main controller for Genesys Widgets and has no UI. It controls all startup routines, global configurations, and extensions, and it executes the onReady event and distributes changes to theme, language, mobile mode, and other application-wide effects.
 ===Usage===
@@ Line 21: / Line 18: @@
 ===Mobile Support===
 App has built-in mobile detection and can automatically notify all widgets to switch to mobile mode. You can also control this manually.
 |Status=No
 }}{{Section
@@ Line 28: / Line 23: @@
 |anchor=config
 |alignment=Vertical
 |structuredtext====Description===
 App uses the configuration property '_genesys.widgets.main'. App controls the Genesys Widgets product as a whole, handling themes, languages, and mobile devices.
@@ Line 78: / Line 71: @@
 {{!}}object
 {{!}}An object list containing the CSS classname for each theme. The property names are used to select the theme in the 'theme' property, for example {dark:'cx-theme-dark', light:'cx-theme-light', 'red':'cx-theme-red', 'blue':'cx-theme-blue'}.
 Where 'dark' and 'light' are the built-in themes provided in Genesys Widgets and 'red' and 'blue' are example custom theme names you may create on your own. {{NoteFormat|It is not necessary to define the 'dark' and 'light' theme as shown in this example. It is included to help show how the formatting works. Whatever you put in this object will be merged with the default themes object internally.|}}
 {{!}}{dark: 'cx-theme-dark', light: 'cx-theme-light'}
@@ Line 192: / Line 184: @@
 {{!}}-
 {{!}}}
 |Status=No
 }}{{Section
 |sectionHeading=Localization
 |alignment=Vertical
 |structuredtext=No localization options.
 |Status=No
 }}{{Section
 |sectionHeading=API Commands
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can call commands on other registered plugins. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 607: / Line 589: @@
 {{!}}}
 <br />
 |Status=No
 }}{{Section
 |sectionHeading=API Events
 |alignment=Vertical
 |structuredtext=Once you've registered your plugin on the bus, you can subscribe to and listen for published events. Here's how to use the global bus object to register a new plugin on the bus.
@@ Line 646: / Line 623: @@
 {{!}}{{!}}{timeFormat: iTimeFormat}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn how to control your widgets.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 5: / Line 5: @@
 |Context=Learn how to control your widgets.
 |ComingSoon=No
-|Platform=PureEngage
+|Platform=GenesysEngage-onpremises
 |Prereq=
 |Section={{Section

@@ Line 55: / Line 55: @@
 			secure: true,
 			domain: 'genesys.com',
-			path: '/'
+			path: '/',
+		}
 	},
@@ Line 178: / Line 179: @@
 . 'expires' - Specifies the number of days, either from time of creation or from a date instance, until the cookie is to be removed.
 'domain' and 'path' can be used to make cookies compatible with environments that use a non FQDN URL, such as an intranet hostname. However, the domain should only be manually set in production if the automated values are causing problems. Otherwise, rely on the automated domain and path.
 Note: The values are automatically set by Widgets to support cross-sub-domain cookies. Modifying these options overrides the automated values and might break cross-sub-domain cookie support if not properly set.
 For usage, please refer to the above example.
-{{!}}none
+{{!}}{sameSite:'Strict'}
 {{!}}n/a
-{{!}}9.0.013.01
+{{!}}9.0.017.01
 {{!}}-
 {{!}}onReady

WID/Current/SDK/App-combined - Revision history

WikiSysop at 11:00, June 17, 2022

Chrissy.forrest@genesys.com: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"