Class Index | File Index

Classes


Namespace notifier

The notifier namespace provides a single function, namely notify which can provide notification pop-ups to the user.

To access this namespace, call require('notifier').

Namespace Summary
Constructor Attributes Constructor Name and Description
 
notifier is something that must be accessed via a require().
Method Summary
Method Attributes Method Name and Description
<static>  
notifier.notify(message, duration, callback)
Shows a pop-up notification in Content Studio.
Namespace Detail
notifier
notifier is something that must be accessed via a require(). It provides the notify() method.
 var n = require("notifier");
Method Detail
<static> notifier.notify(message, duration, callback)
Shows a pop-up notification in Content Studio. The notification will appear in a way that does not interfere with Content Studio's
n.notify("Hello, World");
n.notify("Something important just happened", function() {
  n.notify("No, just kidding");
});
Parameters:
{String} message
The text to provide in the pop-up, required.
{Number} duration Optional, Default: 3000 (3 seconds)
The length of time (in milliseconds) to show the pop-up
{Function} callback Optional
A function that will be invoked after the notification has completed, and has been removed from the screen.

Documentation generated by JsDoc Toolkit 2.3.2 on Thu Apr 11 2019 16:00:43 GMT+0200 (CEST)