Package-level declarations

Types

open class PushEvent(val type: EventType<PushEvent>, init: PushEventInit = definedExternally) : ExtendableEvent

The PushEvent interface of the Push API represents a push message that has been received. Available only in secure contexts.

PushEventInit

interface PushEventInit : ExtendableEventInit

MDN Reference

PushManager

open class PushManager

The PushManager interface of the Push API provides a way to receive notifications from third-party servers as well as request URLs for push notifications. Available only in secure contexts.

PushMessageData

open class PushMessageData

The PushMessageData interface of the Push API provides methods which let you retrieve the push data sent by a server in various formats. Available only in secure contexts.

PushMessageDataInit

typealias PushMessageDataInit = JsAny

PushSubscription

open class PushSubscription

The PushSubscription interface of the Push API provides a subscription's URL endpoint along with the public key and secrets that should be used for encrypting push messages to this subscription. Available only in secure contexts.

PushSubscriptionChangeEvent

open class PushSubscriptionChangeEvent(val type: EventType<PushSubscriptionChangeEvent>, init: PushSubscriptionChangeEventInit = definedExternally) : ExtendableEvent

Available only in secure contexts.

PushSubscriptionChangeEventInit

interface PushSubscriptionChangeEventInit : ExtendableEventInit

MDN Reference

PushSubscriptionJSON

interface PushSubscriptionJSON

PushSubscriptionOptions

open class PushSubscriptionOptions

The PushSubscriptionOptions interface of the Push API represents the options associated with a push subscription. Available only in secure contexts.

PushSubscriptionOptionsInit

interface PushSubscriptionOptionsInit

Properties

auth

val PushEncryptionKeyName.Companion.auth: PushEncryptionKeyName

p256dh

val PushEncryptionKeyName.Companion.p256dh: PushEncryptionKeyName

PUSH

val PushEvent.Companion.PUSH: EventType<PushEvent>

Functions

asInit

inline fun PushEvent.asInit(): PushEventInit

inline fun PushSubscriptionChangeEvent.asInit(): PushSubscriptionChangeEventInit

getSubscription

inline suspend fun PushManager.getSubscription(): PushSubscription?

The PushManager.getSubscription() method of the PushManager interface retrieves an existing push subscription.

permissionState

inline suspend fun PushManager.permissionState(): PermissionState

inline suspend fun PushManager.permissionState(options: PushSubscriptionOptionsInit): PermissionState

The permissionState() method of the PushManager interface returns a Promise that resolves to a string indicating the permission state of the push manager.

inline suspend fun PushManager.subscribe(): PushSubscription

inline suspend fun PushManager.subscribe(options: PushSubscriptionOptionsInit): PushSubscription

The subscribe() method of the PushManager interface subscribes to a push service.

unsubscribe

inline suspend fun PushSubscription.unsubscribe(): Boolean

The unsubscribe() method of the PushSubscription interface returns a Promise that resolves to a boolean value when the current subscription is successfully unsubscribed.