web.Notification — clojure-interop/cljs-web-api 1.0.0

The Notification interface of the Notifications API is used to and display desktop notifications to the user.

actions cljs

(actions this)

Property.

The actions read-only property of the web.Notification interface the list of web.NotificationAction objects set using the actions when creating the notification using the web.Notification()

var actions[] = Notification.actions;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/actions

badge cljs

(badge this)

Property.

The badge property of the web.Notification interface returns URL of the image used to represent the notification when there not enough space to display the notification itself.

var url = Notification.badge

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/badge

body cljs

(body this)

Property.

The body read-only property of the web.Notification interface the body string of the notification, as specified in the body of the web.Notification() constructor.

var body = Notification.body;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/body

close cljs

(close this)

Method.

The close() method of the web.Notification interface is used close a previously displayed notification.

Notification.close();

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/close

constructor cljs

Constructor.

The Notification() constructor creates a new web.Notification object instance, which represents a user notification.

title Defines a title for the notification, which is shown at the top of the notification window. options Optional An options object containing any custom settings that you want to apply to the notification. The possible options are:

dir: The direction in which to display the notification. It defaults to auto, which just adopts the browser's language setting behavior, but you can override that behaviour by setting values of ltr and rtl (although most browsers seem to ignore these settings.) lang: The notification's language, as specified using a dom.DOMString representing a BCP 47 language tag. See the Sitepoint ISO 2 letter language codes page for a simple reference. badge: A web.USVString containing the URL of the image used to represent the notification when there isn't enough space to display the notification itself. body: A dom.DOMString representing the body text of the notification, which is displayed below the title. tag: A dom.DOMString representing an identifying tag for the notification. icon: A web.USVString containing the URL of an icon to be displayed in the notification. image: a web.USVString containing the URL of an image to be displayed in the notification. data: Arbitrary data that you want associated with the notification. This can be of any data type. vibrate: A vibration pattern for the device's vibration hardware to emit with the notification. renotify: A web.Boolean specifying whether the user should be notified after a new notification replaces an old one. The default is false, which means they won't be notified. requireInteraction: Indicates that a notification should remain active until the user clicks or dismisses it, rather than closing automatically. The default value is false. actions: An array of web.NotificationActions representing the actions available to the user when the notification is presented. These are options the user can choose among in order to act on the action within the context of the notification itself. The action's name is sent to the service worker notification handler to let it know the action was selected by the user.

The following options are listed in the most up-to-date specification, but aren 't supported in any browsers yet. It's advisable to keep checking back regularly to see if the status of these has updated, and let us know if you find any out-of-date information.

silent: A web.Boolean specifying whether the notification is silent (no sounds or vibrations issued), regardless of the device settings. The default is false, which means it won't be silent. noscreen: A web.Boolean specifying whether the notification firing enable the device's screen or not. The default is false, which means it enables the screen. sticky: A web.Boolean specifying whether the notification is "sticky", i.e. not easily clearable by the user. The default is false, which means it won't be sticky.

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/Notification

data cljs

(data this)

Property.

The data read-only property of the web.Notification interface a structured clone of the notification's data, as specified in data option of the web.Notification() constructor.

var data = Notification.data;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/data

dir cljs

(dir this)

Property.

The dir read-only property of the web.Notification interface the text direction of the notification, as specified in the dir of the web.Notification() constructor.

var direction = Notification.dir;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/dir

icon cljs

(icon this)

Property.

The icon read-only property of the web.Notification interface the URL of an icon to be displayed as part of the notification, specified in the icon option of the web.Notification() constructor.

var icon = Notification.icon;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/icon

image cljs

(image this)

Property.

The image read-only property of the web.Notification interface the URL of an image to be displayed as part of the notification

var image = Notification.image;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/image

lang cljs

(lang this)

Property.

The lang read-only property of the web.Notification interface the text direction of the notification, as specified in the lang of the web.Notification() constructor.

var language = Notification.lang;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/lang

onclick cljs

(onclick this)

Property.

The onclick property of the web.Notification interface specifies event listener to receive click events. These events occur when user clicks on a displayed web.Notification.

`Notification.onclick = function(event) { ... };

The default behavior is to move the focus to the viewport of the notification's related browsing context. If you don't want that behaviour, call preventDefault() on the event object.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onclick

onclose cljs

(onclose this)

Property.

The onclose property of the web.Notification interface specifies event listener to receive close events. These events occur when web.Notification is closed.

Notification.onclose = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onclose

onerror cljs

(onerror this)

Property.

The onerror property of the web.Notification interface specifies event listener to receive error events. These events occur when goes wrong with a web.Notification (in many cases an error the notification from being displayed.)

Notification.onerror = EventListener;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onerror

onshow cljs

(onshow this)

Property.

The onshow property of the web.Notification interface specifies event listener to receive show events. These events occur when web.Notification is displayed.

Notification.onshow = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onshow

permission cljs

(permission this)

Property.

The permission read-only property of the web.Notification interface the current permission granted by the user for the current origin display web notifications.

var permission = Notification.permission;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/permission

renotify cljs

(renotify this)

Property.

The renotify read-only property of the web.Notification interface whether the user should be notified after a new notification an old one, as specified in the renotify option of the web.Notification()

var renotify = Notification.renotify;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/renotify

request-permission cljs

(request-permission this & args)

Method.

The requestPermission() method of the web.Notification interface permission from the user for the current origin to display notifications.

`The latest spec has updated this method to a promise-based syntax that works like this:

Notification.requestPermission().then(function(permission) { ... });

Previously, the syntax was based on a simple callback; this version is now deprecated:

Notification.requestPermission(callback);

Safari Version 12.0.3 still uses callback to get the permission.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/requestPermission

require-interaction cljs

(require-interaction this)

Property.

The requireInteraction read-only property of the web.Notification returns a web.Boolean indicating that a notification should active until the user clicks or dismisses it, rather than closing

function spawnNotification(theTitle,theBody,shouldRequireInteraction) { var options = { body: theBody, requireInteraction: shouldRequireInteraction } var n = new Notification(theTitle,options); }

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/requireInteraction

set-actions! cljs

(set-actions! this val)

Property.

The actions read-only property of the web.Notification interface the list of web.NotificationAction objects set using the actions when creating the notification using the web.Notification()

var actions[] = Notification.actions;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/actions

set-badge! cljs

(set-badge! this val)

Property.

The badge property of the web.Notification interface returns URL of the image used to represent the notification when there not enough space to display the notification itself.

var url = Notification.badge

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/badge

set-body! cljs

(set-body! this val)

Property.

The body read-only property of the web.Notification interface the body string of the notification, as specified in the body of the web.Notification() constructor.

var body = Notification.body;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/body

set-data! cljs

(set-data! this val)

Property.

The data read-only property of the web.Notification interface a structured clone of the notification's data, as specified in data option of the web.Notification() constructor.

var data = Notification.data;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/data

set-dir! cljs

(set-dir! this val)

Property.

The dir read-only property of the web.Notification interface the text direction of the notification, as specified in the dir of the web.Notification() constructor.

var direction = Notification.dir;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/dir

set-icon! cljs

(set-icon! this val)

Property.

The icon read-only property of the web.Notification interface the URL of an icon to be displayed as part of the notification, specified in the icon option of the web.Notification() constructor.

var icon = Notification.icon;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/icon

set-image! cljs

(set-image! this val)

Property.

The image read-only property of the web.Notification interface the URL of an image to be displayed as part of the notification

var image = Notification.image;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/image

set-lang! cljs

(set-lang! this val)

Property.

The lang read-only property of the web.Notification interface the text direction of the notification, as specified in the lang of the web.Notification() constructor.

var language = Notification.lang;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/lang

set-onclick! cljs

(set-onclick! this val)

Property.

The onclick property of the web.Notification interface specifies event listener to receive click events. These events occur when user clicks on a displayed web.Notification.

`Notification.onclick = function(event) { ... };

The default behavior is to move the focus to the viewport of the notification's related browsing context. If you don't want that behaviour, call preventDefault() on the event object.`

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onclick

set-onclose! cljs

(set-onclose! this val)

Property.

The onclose property of the web.Notification interface specifies event listener to receive close events. These events occur when web.Notification is closed.

Notification.onclose = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onclose

set-onerror! cljs

(set-onerror! this val)

Property.

The onerror property of the web.Notification interface specifies event listener to receive error events. These events occur when goes wrong with a web.Notification (in many cases an error the notification from being displayed.)

Notification.onerror = EventListener;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onerror

set-onshow! cljs

(set-onshow! this val)

Property.

The onshow property of the web.Notification interface specifies event listener to receive show events. These events occur when web.Notification is displayed.

Notification.onshow = function() { ... };

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/onshow

set-permission! cljs

(set-permission! this val)

Property.

The permission read-only property of the web.Notification interface the current permission granted by the user for the current origin display web notifications.

var permission = Notification.permission;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/permission

set-renotify! cljs

(set-renotify! this val)

Property.

The renotify read-only property of the web.Notification interface whether the user should be notified after a new notification an old one, as specified in the renotify option of the web.Notification()

var renotify = Notification.renotify;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/renotify

set-require-interaction! cljs

(set-require-interaction! this val)

Property.

The requireInteraction read-only property of the web.Notification returns a web.Boolean indicating that a notification should active until the user clicks or dismisses it, rather than closing

function spawnNotification(theTitle,theBody,shouldRequireInteraction) { var options = { body: theBody, requireInteraction: shouldRequireInteraction } var n = new Notification(theTitle,options); }

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/requireInteraction

set-silent! cljs

(set-silent! this val)

Property.

The silent read-only property of the web.Notification interface whether the notification should be silent, i.e., no sounds or should be issued, regardless of the device settings. This is in the renotify option of the web.Notification() constructor.

var silent = Notification.silent;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/silent

set-tag! cljs

(set-tag! this val)

Property.

The tag read-only property of the web.Notification interface an identifying tag for the notification, as specified in the option of the web.Notification() constructor.

var tag = Notification.tag;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/tag

set-timestamp! cljs

(set-timestamp! this val)

Property.

The timestamp read-only property of the web.Notification interface a DOMTimeStamp, as specified in the timestamp option of the web.Notification()

var timestamp = Notification.timestamp;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/timestamp

set-title! cljs

(set-title! this val)

Property.

The title read-only property of the web.Notification interface the title of the notification, as specified in the title parameter the web.Notification() constructor.

var title = Notification.title;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/title

set-vibrate! cljs

(set-vibrate! this val)

Property.

The vibrate read-only property of the web.Notification interface a a vibration pattern for the device's vibration hardware to when the notification fires. This is specified in the vibrate of the web.Notification() constructor.

var vibrate = Notification.vibrate;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/vibrate

silent cljs

(silent this)

Property.

The silent read-only property of the web.Notification interface whether the notification should be silent, i.e., no sounds or should be issued, regardless of the device settings. This is in the renotify option of the web.Notification() constructor.

var silent = Notification.silent;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/silent

tag cljs

(tag this)

Property.

The tag read-only property of the web.Notification interface an identifying tag for the notification, as specified in the option of the web.Notification() constructor.

var tag = Notification.tag;

See also: https://developer.mozilla.org/en-US/docs/Web/API/Notification/tag

timestamp cljs

(timestamp this)

Property.

The timestamp read-only property of the web.Notification interface a DOMTimeStamp, as specified in the timestamp option of the web.Notification()

var timestamp = Notification.timestamp;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/timestamp

title cljs

(title this)

Property.

The title read-only property of the web.Notification interface the title of the notification, as specified in the title parameter the web.Notification() constructor.

var title = Notification.title;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/title

vibrate cljs

(vibrate this)

Property.

The vibrate read-only property of the web.Notification interface a a vibration pattern for the device's vibration hardware to when the notification fires. This is specified in the vibrate of the web.Notification() constructor.

var vibrate = Notification.vibrate;

See also: https://developer.mozilla.org/en-US/docs/Web/API/notification/vibrate