NotificationAPI

Types

getNotificationOptions

type getNotificationOptions = {mutable tag?: string}

Record fields

tag

option< string >

notification

This Notifications API interface is used to configure and display desktop notifications to the user. See Notification on MDN

type notification = {
  permission: notificationPermission,
  title: string,
  dir: notificationDirection,
  lang: string,
  body: string,
  tag: string,
  icon: string,
  badge: string,
  silent: Null.t<bool>,
  requireInteraction: bool,
  data?: JSON.t,
}

Record fields

permission

notificationPermission

Read more on MDN

title

string

Read more on MDN

dir

notificationDirection

Read more on MDN

lang

string

Read more on MDN

body

string

Read more on MDN

tag

string

Read more on MDN

icon

string

Read more on MDN

badge

string

Read more on MDN

silent

Null.t< bool >

Read more on MDN

requireInteraction

bool

Read more on MDN

data

option< JSON.t >

Read more on MDN

Module

There are methods and helpers defined in Notification .

notificationAction

An array of actions to display in the notification, for which the default is an empty array. Read more on MDN

type notificationAction = {
  action: string,
  title: string,
  icon?: string,
}

Record fields

action

string

title

string

icon

option< string >

notificationDirection

type notificationDirection =
  | @as("auto") Auto
  | @as("ltr") Ltr
  | @as("rtl") Rtl

notificationEvent

type notificationEvent = {
  type_: WebAPI.EventAPI.eventType,
  target: Null.t<WebAPI.EventAPI.eventTarget>,
  currentTarget: Null.t<WebAPI.EventAPI.eventTarget>,
  eventPhase: int,
  bubbles: bool,
  cancelable: bool,
  defaultPrevented: bool,
  composed: bool,
  isTrusted: bool,
  timeStamp: float,
  action: string,
  notification: notification,
}

Record fields

type_

WebAPI.EventAPI.eventType

Returns the type of event, e.g. "click", "hashchange", or "submit". Read more on MDN

target

Null.t< WebAPI.EventAPI.eventTarget >

Returns the object to which event is dispatched (its target). Read more on MDN

currentTarget

Null.t< WebAPI.EventAPI.eventTarget >

Returns the object whose event listener's callback is currently being invoked. Read more on MDN

eventPhase

int

Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE. Read more on MDN

bubbles

bool

Returns true or false depending on how event was initialized. True if event goes through its target's ancestors in reverse tree order, and false otherwise. Read more on MDN

cancelable

bool

Returns true or false depending on how event was initialized. Its return value does not always carry meaning, but true can indicate that part of the operation during which event was dispatched, can be canceled by invoking the preventDefault() method. Read more on MDN

defaultPrevented

bool

Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise. Read more on MDN

composed

bool

Returns true or false depending on how event was initialized. True if event invokes listeners past a ShadowRoot node that is the root of its target, and false otherwise. Read more on MDN

isTrusted

bool

Returns true if event was dispatched by the user agent, and false otherwise. Read more on MDN

timeStamp

float

Returns the event's timestamp as the number of milliseconds measured relative to the time origin. Read more on MDN

action

string

Read more on MDN

notification

notification

Read more on MDN

notificationOptions

type notificationOptions = {
  mutable dir?: notificationDirection,
  mutable lang?: string,
  mutable body?: string,
  mutable tag?: string,
  mutable icon?: string,
  mutable badge?: string,
  mutable silent?: Null.t<bool>,
  mutable requireInteraction?: bool,
  mutable data?: JSON.t,
  mutable actions?: array<notificationAction>,
}

Record fields

dir

option< notificationDirection >

lang

option< string >

body

option< string >

tag

option< string >

icon

option< string >

badge

option< string >

silent

option< Null.t< bool > >

requireInteraction

option< bool >

data

option< JSON.t >

actions

option< array< notificationAction > >

notificationPermission

type notificationPermission =
  | @as("default") Default
  | @as("denied") Denied
  | @as("granted") Granted

notificationPermissionCallback

type notificationPermissionCallback = notificationPermission => unit