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

Chrissyforrest: Published

2020-10-22T21:30:09Z

Published

Chrissyforrest: Published

2020-07-30T21:03:34Z

Published

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

2020-07-25T02:39:42Z

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

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

2020-07-15T11:50:14Z

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

Chrissyforrest: Published

2020-05-22T15:48:36Z

Published

Show changes

Chrissyforrest: Published

2020-04-09T21:49:54Z

Published

WikiSysop at 13:49, January 17, 2020

2020-01-17T13:49:19Z

Mgionet: Published

2019-09-06T18:15:51Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Toaster
|Role=Developer
|TocName=Toaster
|Platform=PureEngage
|ComingSoon=No
|Context=Learn how to use a toast view control that widgets can inject their UI into.
|Section={{Section
|Type=Structured
|sectionHeading=Overview
|alignment=Vertical
|structuredtext=The Toaster plugin provides a toast view control that widgets can inject their UI into, accepting the HTML UI, placing it inside a toast view, and displaying the UI onscreen in the lower-bottom-right of the screen. When it is opened, it slides up from the bottom. When it is closed, it slides down until it is offscreen.

Toaster provides these benefits:
* Shows UI as a slide-up toast view in the lower-bottom-right of the screen.
* Open and close transition animations.
* No overlapping toasts, only one at a time. Automatically managed by the Toaster plugin.

===Usage===
Toaster is easy to use: you simply open and close it. When you call Toaster.open, you pass in the HTML content you want to show. If you call Toaster.open again while a toast is already open, it will automatically close the previous toast before showing yours (unless the previous toast has reserved the view to prevent new toasts).

{{NoteFormat|Only one toast can be shown at a time. If you attempt to open a second toast, the first toast will be dismissed automatically before showing the second toast.}}
===Namespace===
The Toaster plugin has the following namespaces tied up with each of the following types.
{{{!}} class="wikitable" style="width: auto;"
{{!}}-
!{{!}}Type
!{{!}}Namespace
{{!}}-
{{!}}{{!}}CXBus—{{Link-SomewhereInThisVersion|manual=SDK|topic=Toaster-combined|anchor=commands|display text=API commands}} & {{Link-SomewhereInThisVersion|manual=SDK|topic=Toaster-combined|anchor=events|display text=API events}}
{{!}}{{!}}Toaster
{{!}}-
{{!}}{{!}}CSS
{{!}}{{!}}.cx-toaster
{{!}}}

===Customization===
Toaster does not have customization options.
===Mobile Support===
Toaster does not have mobile-specific styles at this time.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Configuration
|alignment=Vertical
|structuredtext=Toaster does not have configuration options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=Localization
|alignment=Vertical
|structuredtext=Toaster does not have localization options.
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API Commands
|anchor=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('Toaster.close');</source>
===open===
Opens the Toaster UI.
====Example====
<source lang='javascript'>
oMyPlugin.command('Toaster.open', {

type: 'generic',
title: 'Toaster Title',
body: 'Toaster Body',
icon: 'chat',
controls: 'close',
immutable: false,
buttons:{

type: 'binary',
primary: 'Accept',
secondary: 'Decline'
}

}).done(function(e){

// Toaster opened successfully

}).fail(function(e){

// Toaster failed to open properly
});
</source>

====Options====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Option
!{{!}}Type
!{{!}}Description
{{!}}-
{{!}}{{!}}type
{{!}}{{!}}string
{{!}}{{!}}Specifies the type of body content that can be provided to toaster window. Generic type shows the default body content and custom type overrides the default html body content.
{{!}}-
{{!}}{{!}}title
{{!}}{{!}}string
{{!}}{{!}}Heading title to display on the toaster window.
{{!}}-
{{!}}{{!}}body
{{!}}{{!}}string
{{!}}{{!}}Holds text value for Generic toaster type and html string template for Custom toaster type.
{{!}}-
{{!}}{{!}}icon
{{!}}{{!}}string
{{!}}{{!}}The CSS class name for an icon.
{{!}}-
{{!}}{{!}}controls
{{!}}{{!}}string
{{!}}{{!}}Show close and minimize controls on toaster window.
{{!}}-
{{!}}{{!}}buttons
{{!}}{{!}}object
{{!}}{{!}}Define the type of buttons.
{{!}}-
{{!}}{{!}}buttons.type
{{!}}{{!}}string
{{!}}{{!}}Shows two buttons on the toaster.
{{!}}-
{{!}}{{!}}buttons.primary
{{!}}{{!}}string
{{!}}{{!}}Text to be shown on primary button.
{{!}}-
{{!}}{{!}}buttons.secondary
{{!}}{{!}}string
{{!}}{{!}}Text to be shown on secondary button.
{{!}}-
{{!}}{{!}}immutable
{{!}}{{!}}boolean
{{!}}{{!}}When set to true, toaster cannot be closed by other plugins.
{{!}}}

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When Toaster is successfully opened
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When no toaster type is specified
{{!}}{{!}}'No content was provided. Toaster has ignored your command'
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When toaster is already opened
{{!}}{{!}}'Toaster view is currently reserved'
{{!}}}

===close===
Closes the Toaster UI.
====Example====
<source lang='javascript'>
oMyPlugin.command('Toaster.close').done(function(e){

// Toaster closed successfully

}).fail(function(e){

// Toaster failed to close
});
</source>

====Resolutions====

{{{!}} class="wikitable"
{{!}}-
!{{!}}Status
!{{!}}When
!{{!}}Returns
{{!}}-
{{!}}{{!}}resolved
{{!}}{{!}}When toaster is successfully closed.
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When Toaster is already closed.
{{!}}{{!}}'Toaster view is already closed'
{{!}}-
{{!}}{{!}}rejected
{{!}}{{!}}When Toaster view is immutable.
{{!}}{{!}}'Toaster view is currently reserved'
{{!}}}
|advanced=No
|Status=No
}}{{Section
|Type=Structured
|sectionHeading=API Events
|anchor=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('Toaster.ready', function(e){});</source>
{{{!}} class="wikitable"
{{!}}-
!{{!}}Name
!{{!}}Description
!{{!}}Data
{{!}}-
{{!}}{{!}}ready
{{!}}{{!}}The Toaster plugin is initialized and ready to accept commands
{{!}}{{!}}n/a
{{!}}-
{{!}}{{!}}closed
{{!}}{{!}}The Toaster plugin has been removed from the screen
{{!}}{{!}}n/a
{{!}}}
|advanced=No
|Status=No
}}
}}

@@ Line 10: / Line 10: @@
 |sectionHeading=Overview
 |alignment=Vertical
-|structuredtext=The Toaster plugin provides a toast view control that widgets can inject their UI into, accepting the HTML UI, placing it inside a toast view, and displaying the UI onscreen in the lower-bottom-right of the screen. When it is opened, it slides up from the bottom. When it is closed, it slides down until it is offscreen.
+|structuredtext=The Toaster plugin provides a toast view control that widgets can inject their UI into, accepting the HTML UI, placing it inside a toast view, and displaying the UI on-screen at the lower-bottom-right. When it opens, it slides up from the bottom. When it closes, it slides down until it is off-screen.
 Toaster provides these benefits:
@@ Line 19: / Line 19: @@
 ===Usage===
-Toaster is easy to use; you simply open and close it. When you call Toaster.open, you pass in the HTML content you want to show. If you call Toaster.open again while a toast is already open, it will automatically close the previous toast before showing yours (unless the previous toast has reserved the view to prevent new toasts).
+Toaster is easy to use - you simply open and close it. When you call Toaster.open, you pass in the HTML content you want to show. If you call Toaster.open again while a toast is already open, it will automatically close the previous toast before showing yours (unless the previous toast has reserved the view to prevent new toasts).
 ===Namespace===
 The Toaster plugin has the following namespaces tied to each of the following types.
@@ Line 55: / Line 55: @@
 |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}}
@@ Line 203: / Line 203: @@
 |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 5: / Line 5: @@
 |Context=Learn how to use a toast view control that widgets can inject their UI into.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

@@ Line 3: / Line 3: @@
 |DisplayName=Toaster
 |TocName=Toaster
-|Context=Learn how to use a toast view control that widgets can inject their UI into.
+|Context=Learn how to use a toast view control into which widgets can inject their UI.
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
-|Prereq=
+|Role=Developer
 |Section={{Section
 |sectionHeading=Overview
 |alignment=Vertical
 |structuredtext=The Toaster plugin provides a toast view control that widgets can inject their UI into, accepting the HTML UI, placing it inside a toast view, and displaying the UI onscreen in the lower-bottom-right of the screen. When it is opened, it slides up from the bottom. When it is closed, it slides down until it is offscreen.
@@ Line 19: / Line 16: @@
 *Shows UI as a slide-up toast view in the lower-bottom-right of the screen.
 *Open and close transition animations.
-*No overlapping toasts, only one at a time. Automatically managed by the Toaster plugin.
+*No overlapping toasts; only one at a time. Automatically managed by the Toaster plugin.
 ===Usage===
 Toaster is easy to use; you simply open and close it. When you call Toaster.open, you pass in the HTML content you want to show. If you call Toaster.open again while a toast is already open, it will automatically close the previous toast before showing yours (unless the previous toast has reserved the view to prevent new toasts).
 ===Namespace===
-The Toaster plugin has the following namespaces tied up with each of the following types.
+The Toaster plugin has the following namespaces tied to each of the following types.
 {{{!}} class="wikitable" style="width: auto;"
 {{!}}-
@@ Line 38: / Line 33: @@
 {{!}}{{!}}.cx-toaster
 {{!}}}
 ===Customization===
 Toaster does not have customization options.
-===Mobile Support===
+===Mobile support===
 Toaster does not have mobile-specific styles at this time.
 |Status=No
 }}{{Section
 |sectionHeading=Configuration
 |alignment=Vertical
 |structuredtext=Toaster does not have configuration options.
 |Status=No
 }}{{Section
 |sectionHeading=Localization
 |alignment=Vertical
 |structuredtext=Toaster does not have localization options.
 |Status=No
 }}{{Section
@@ Line 71: / Line 53: @@
 |anchor=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 169: / Line 149: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When Toaster is successfully opened
+{{!}}{{!}}Toaster is successfully opened
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When no Toaster type is specified
+{{!}}{{!}}No Toaster type is specified
 {{!}}{{!}}'No content was provided. Toaster has ignored your command'
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When Toaster is already opened
+{{!}}{{!}}Toaster is already opened
 {{!}}{{!}}'Toaster view is currently reserved'
 {{!}}}
@@ Line 205: / Line 185: @@
 {{!}}-
 {{!}}{{!}}resolved
-{{!}}{{!}}When Toaster is successfully closed.
+{{!}}{{!}}Toaster is successfully closed
 {{!}}{{!}}n/a
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When Toaster is already closed.
+{{!}}{{!}}Toaster is already closed
 {{!}}{{!}}'Toaster view is already closed'
 {{!}}-
 {{!}}{{!}}rejected
-{{!}}{{!}}When Toaster view is immutable.
+{{!}}{{!}}Toaster view is immutable
 {{!}}{{!}}'Toaster view is currently reserved'
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 223: / Line 201: @@
 |anchor=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 247: / Line 223: @@
 {{!}}{{!}}n/a
 {{!}}}
 |Status=No
 }}
 }}

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

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

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"