AlertingApi

Handles aspects of alerting and attention of this app with Genesys Cloud

since 1.0.0

• BaseApi

↳ AlertingApi

• setAttentionCount
• showToastPopup

▸ setAttentionCount(count: number): void

Displays badging for unread messages and notifications

myClientApp.alerting.setAttentionCount(2);

myClientApp.alerting.setAttentionCount(0);

since 1.0.0

Parameters:

Returns: void

▸ showToastPopup‹MessageType, Timeout›(title: string, message: string, options?: ToastOptions‹MessageType, Timeout›): void

Displays a toast popup.

Permanent/Sticky toasts are not allowed. Therefore, toasts must specify either a manual dismissal (showCloseButton: true) or an automatic dismissal (timeout > 0). Both showCloseButton and timeout can be specified to provide both dismissal options.

Error toasts (type: 'error') require manual dismissal and must be explictly specified with showCloseButton: true. TypeScript users will also specify timeout: 0 while JavaScript users can specify 0 or omit the prop entirely. The timeout prop will be ignored regardless.

Toast Options:

The type parameters impact the options config. The MessageType type extends 'error' | 'info' | 'success', and when it is set to 'error', it enforces that timeout is 0. The Timeout type extends number, and when set to 0 it enforces that showCloseButton is true to prevent a permanent toast message.

myClientApp.alerting.showToastPopup("Hello world", "Hello world, how are you doing today?");

var options = {
type: 'success'
};
myClientApp.alerting.showToastPopup("Hello world", "Hello world, how are you doing today?", options);

var options = {
id: 'greeting',
timeout: 0,
showCloseButton: true
};
myClientApp.alerting.showToastPopup("Hello world", "Hello world, how are you doing today?", options);
// Set new id so the messages can show together
options.id = 'exit'
myClientApp.alerting.showToastPopup("Goodbye world", "See you later world", options);

var options = {
id: 'mdExample',
markdownMessage: true
};
myClientApp.alerting.showToastPopup("Hello world", "Hello :earth_americas: How are *you* doing today?", options);

since 1.0.0

Type parameters:

▪ MessageType: ValidMessageType

▪ Timeout: number

Parameters:

Returns: void