PushAPI

Types

applicationServerKey

type applicationServerKey

Module

There are methods and helpers defined in ApplicationServerKey .

permissionState

type permissionState =
  | @as("denied") Denied
  | @as("granted") Granted
  | @as("prompt") Prompt

pushEncryptionKeyName

type pushEncryptionKeyName =
  | @as("auth") Auth
  | @as("p256dh") P256dh

pushEvent

type pushEvent = {
  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,
  data?: pushMessageData,
}

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

data

option< pushMessageData >

Read more on MDN

Module

There are methods and helpers defined in PushEvent .

pushManager

This Push API interface provides a way to receive notifications from third-party servers as well as request URLs for push notifications. See PushManager on MDN

type pushManager = {
  supportedContentEncodings: array<string>,
}

Record fields

supportedContentEncodings

array< string >

Read more on MDN

Module

There are methods and helpers defined in PushManager .

pushMessageData

type pushMessageData

Module

There are methods and helpers defined in PushMessageData .

pushSubscription

This Push API interface provides a subcription's URL endpoint and allows unsubscription from a push service. See PushSubscription on MDN

type pushSubscription = {
  endpoint: string,
  expirationTime: Null.t<int>,
  options: pushSubscriptionOptions,
}

Record fields

endpoint

string

Read more on MDN

expirationTime

Null.t< int >

Read more on MDN

options

pushSubscriptionOptions

Read more on MDN

Module

There are methods and helpers defined in PushSubscription .

pushSubscriptionJSON

type pushSubscriptionJSON = {
  mutable endpoint?: string,
  mutable expirationTime?: Null.t<int>,
  mutable keys?: pushSubscriptionJSONKeys,
}

Record fields

endpoint

option< string >

expirationTime

option< Null.t< int > >

keys

option< pushSubscriptionJSONKeys >

pushSubscriptionJSONKeys

type pushSubscriptionJSONKeys = {
  p256dh: string,
  auth: string,
}

Record fields

p256dh

string

Base64URL-encoded ArrayBuffer value

auth

string

Base64URL-encoded ArrayBuffer value

pushSubscriptionOptions

See PushSubscriptionOptions on MDN

type pushSubscriptionOptions = {
  userVisibleOnly: bool,
  applicationServerKey: applicationServerKey,
}

Record fields

userVisibleOnly

bool

Read more on MDN

applicationServerKey

Read more on MDN

pushSubscriptionOptionsInit

type pushSubscriptionOptionsInit = {
  mutable userVisibleOnly?: bool,
  mutable applicationServerKey?: applicationServerKey,
}