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

Chrissyforrest: Published

2020-10-22T21:30:23Z

Published

Chrissyforrest: Published

2020-08-25T14:34:39Z

Published

Chrissyforrest: Published

2020-07-30T21:54:43Z

Published

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

2020-07-25T02:38:39Z

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

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

2020-07-15T11:51:25Z

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

Chrissyforrest: Published

2020-05-22T15:54:02Z

Published

Chrissyforrest: Published

2020-04-09T21:51:00Z

Published

WikiSysop at 13:49, January 17, 2020

2020-01-17T13:49:28Z

Mgionet: Published

2019-09-06T18:15:52Z

Published

New page

{{Article
|Standalone=No
|DisplayName=WindowManager
|Role=Developer
|TocName=WindowManager
|Platform=PureEngage
|ComingSoon=No
|Context=Learn how to use the WindowManager plugin, which provides a controller for several different types of window group.
|Section={{Section
|Type=Structured
|sectionHeading=Overview
|alignment=Vertical
|structuredtext=The WindowManager plugin provides a controller for several different types of window group. HTML UIs added to these WindowManager groups are arranged and managed in accordance with each group's purpose.

One group type is ''Dock View''. Both WebChat and SendMessage utilize this group to show their toast-like UI docked in the lower-bottom-right of the screen. This group automatically stacks the two widgets horizontally. When one of the widgets closes, the stack collapses towards the right. Widgets can register themselves into this WindowManager group and let it do all the work.

Another group type is ''Side Button''. WebChat and SendMessage also use this group to show their launcher buttons on the right side of the screen. Like the dock view, buttons are stacked, but in this case they are stacked vertically. As buttons are added and removed from the group, the button stack collapses to fill in the gaps.
===Usage===
WindowManager has "register" commands for registering your UI into different groups. They all accept one argument, the HTML you want to be handled by WindowManager. You can use 'registerDockView' or 'registerSideButton' at this time. More window management groups will be added in upcoming releases.
===Customization===
WindowManager does not have customization options.
===Screenshots===
<gallery>
WindowsManager_Dark01.png</gallery>
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Configuration
|alignment=Vertical
|structuredtext=WindowManager does not have configuration options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Localization
|alignment=Vertical
|structuredtext=WindowManager does not have localization options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|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.

{{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}}

<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.command('WindowManager.registerDockView', {html: '<div>HTML</div>'});</source>
===registerDockView===
Creates a docked view container to show a widget on the bottom right corner. Its position is adjusted (stacked) to show side by of a widget if already present and is indexed with a tabindex.
====Example====
<source lang='javascript'>
oMyPlugin.command('WindowManager.registerDockView', {html: '<div>Template</div>'}).done(function(e){

// WindowManager registered a dockView successfully

}).fail(function(e){

// WindowManager failed to register a dock view
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}html
{{!}}{{!}}string
{{!}}{{!}}A Widget HTML string template that needs to be shown in dock view.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When the html template is successfully opened and registered in dock view
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no html template is found
{{!}}{{!}}'No html content'
{{!}}}

===registerSideButton===
Registers a button to show on the right side of the screen for a particular plugin. Its position is based on the respective plugin order defined in the array configuration. Currently, this is not supported for external plugins.
====Example====
<source lang='javascript'>
oMyPlugin.command('WindowManager.registerSideButton', {template: '<div>Button Text</div>'}).done(function(e){

// WindowManager registered a side button successfully

}).fail(function(e){

// WindowManager failed to register a side button
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}template
{{!}}{{!}}string
{{!}}{{!}}Custom HTML string template for a button.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When the html button is successfully registered
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no html template is found
{{!}}{{!}}'No button template found to register'
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|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.

{{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}}

<source lang='javascript'>var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

oMyPlugin.subscribe('WindowManager.ready', function(e){});</source>
{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Description
!{{!}}Data
{{!}}-
{{!}}{{!}}ready
{{!}}{{!}}WindowManager is initialized and ready to accept commands.
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}changed
{{!}}{{!}}WindowManager publishes this event when there is any change in the position of widgets on the screen.
{{!}}{{!}}{registry: (object)}
{{!}}}
|advanced=No
|Status=No
}}
}}

@@ Line 43: / Line 43: @@
 |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-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');
@@ Line 145: / Line 145: @@
 |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-SomewhereInThisVersion|manual=SDK|topic=GWCBusExtensions|display text=Genesys Widgets Extensions}} for more information about extending Genesys Widgets.|1}}
 <source lang="javascript">var oMyPlugin = window._genesys.widgets.bus.registerPlugin('MyPlugin');

@@ Line 49: / Line 49: @@
 oMyPlugin.command('WindowManager.registerDockView', {html: '<div>HTML</div>'});</source>
 ===registerDockView===
-Creates a docked view container to show a widget on the bottom right corner. Its position is adjusted (stacked) to show side by side of a widget if already present and is indexed with a tabindex.
+Creates a docked view container to show a widget on the bottom right corner. Its position is adjusted (stacked) to appear beside another widget if already present and is indexed with a tabindex.
 ====Example====
 <source lang="javascript">

@@ Line 5: / Line 5: @@
 |Context=Learn how to use the WindowManager plugin, which provides a controller for several different types of window group.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
-|anchor=
+|anchor=Overview
 |alignment=Vertical
 |structuredtext=The WindowManager plugin provides a controller for several different types of window group. HTML UIs added to these WindowManager groups are arranged and managed in accordance with each group's purpose.
-One group type is ''Dock View''. Both WebChat and SendMessage utilize this group to show their toast-like UI docked in the lower-bottom-right of the screen. This group automatically stacks the two widgets horizontally. When one of the widgets closes, the stack collapses towards the right. Widgets can register themselves into this WindowManager group and let it do all the work.
+One group type is ''Dock View'', which appears as a toast-like UI docked in the lower-bottom-right of the screen. This group automatically stacks widgets horizontally. When one of the widgets closes, the stack collapses toward the right. Widgets can register themselves into this WindowManager group and let it do all the work.
-Another group type is ''Side Button''. WebChat and SendMessage also use this group to show their launcher buttons on the right side of the screen. Like the dock view, buttons are stacked, but in this case they are stacked vertically. As buttons are added and removed from the group, the button stack collapses to fill in the gaps.
+Another group type is ''Side Button'', with its launcher button on the right side of the screen. Like the dock view, buttons are stacked, but in this case they are stacked vertically. As buttons are added and removed from the group, the button stack collapses to fill in the gaps.
 ===Usage===
 WindowManager has "register" commands for registering your UI into different groups. They all accept one argument, the HTML you want to be handled by WindowManager. You can use 'registerDockView' or 'registerSideButton' at this time. More window management groups will be added in upcoming releases.
 ===Customization===
 WindowManager does not have customization options.
-===Screenshots===
+===Screenshot===
-<gallery widths="300" heights="300">
+<gallery widths="100" heights="100">
-File:WindowsManager Dark01.png
+File:Chat widget.PNG
 </gallery>
 |Status=No
 }}{{Section
 |sectionHeading=Configuration
-|anchor=
+|anchor=Configuration
 |alignment=Vertical
 |structuredtext=WindowManager does not have configuration options.
 |Status=No
 }}{{Section
 |sectionHeading=Localization
-|anchor=
+|anchor=Localization
 |alignment=Vertical
 |structuredtext=WindowManager does not have localization options.
 |Status=No
 }}{{Section
 |sectionHeading=API Commands
-|anchor=
+|anchor=APICommands
 |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 63: / Line 49: @@
 oMyPlugin.command('WindowManager.registerDockView', {html: '<div>HTML</div>'});</source>
 ===registerDockView===
-Creates a docked view container to show a widget on the bottom right corner. Its position is adjusted (stacked) to show side by of a widget if already present and is indexed with a tabindex.
+Creates a docked view container to show a widget on the bottom right corner. Its position is adjusted (stacked) to show side by side of a widget if already present and is indexed with a tabindex.
 ====Example====
 <source lang="javascript">
@@ Line 99: / Line 85: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When the html template is successfully opened and registered in dock view
+{{!}}{{!}}The HTML template is successfully opened and registered in dock view.
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no html template is found
+{{!}}{{!}}No HTML template is found.
 {{!}}{{!}}'No html content'
 {{!}}}
@@ Line 145: / Line 131: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When the html button is successfully registered
+{{!}}{{!}}The HTML button is successfully registered.
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no html template is found
+{{!}}{{!}}No HTML template is found.
 {{!}}{{!}}'No button template found to register'
 {{!}}}
 |Status=No
 }}{{Section
 |sectionHeading=API Events
-|anchor=
+|anchor=APIEvents
 |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 182: / Line 164: @@
 {{!}}{{!}}{registry: (object)}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 2: / Line 2: @@
 |Standalone=No
 |DisplayName=WindowManager
 |TocName=WindowManager
 |Platform=PureEngage

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

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"

Chrissyforrest: Published

Chrissyforrest: Published

WikiSysop at 13:49, January 17, 2020

Mgionet: Published

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

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