PushAPI
Types
applicationServerKey
typeapplicationServerKeyModule
There are methods and helpers defined in ApplicationServerKey.
permissionState
typepermissionState=| @as("denied")Denied| @as("granted")Granted| @as("prompt")PromptpushEncryptionKeyName
typepushEncryptionKeyName=| @as("auth")Auth| @as("p256dh")P256dhpushEvent
typepushEvent= {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_
Returns the type of event, e.g. "click", "hashchange", or "submit".Read more on MDN
target
Returns the object to which event is dispatched (its target).Read more on MDN
currentTarget
Returns the object whose event listener's callback is currently being invoked.Read more on MDN
eventPhase
Returns the event's phase, which is one of NONE, CAPTURING_PHASE, AT_TARGET, and BUBBLING_PHASE.Read more on MDN
bubbles
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
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
Returns true if preventDefault() was invoked successfully to indicate cancelation, and false otherwise.Read more on MDN
composed
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
Returns true if event was dispatched by the user agent, and false otherwise.Read more on MDN
timeStamp
Returns the event's timestamp as the number of milliseconds measured relative to the time origin.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
typepushManager= {supportedContentEncodings:array<string>,}Record fields
Module
There are methods and helpers defined in PushManager.
pushSubscription
This Push API interface provides a subcription's URL endpoint and allows unsubscription from a push service.See PushSubscription on MDN
typepushSubscription= {endpoint:string,expirationTime:Null.t<int>,options:pushSubscriptionOptions,}Record fields
Module
There are methods and helpers defined in PushSubscription.
pushSubscriptionJSON
typepushSubscriptionJSON= {mutableendpoint?:string,mutableexpirationTime?:Null.t<int>,mutablekeys?:pushSubscriptionJSONKeys,}Record fields
endpoint
expirationTime
keys
pushSubscriptionJSONKeys
typepushSubscriptionJSONKeys= {p256dh:string,auth:string,}Record fields
p256dh
Base64URL-encoded ArrayBuffer value
auth
Base64URL-encoded ArrayBuffer value
pushSubscriptionOptions
typepushSubscriptionOptions= {userVisibleOnly:bool,applicationServerKey:applicationServerKey,}Record fields
pushSubscriptionOptionsInit
typepushSubscriptionOptionsInit= {mutableuserVisibleOnly?:bool,mutableapplicationServerKey?:applicationServerKey,}