Interface PushSubscription

This Push API interface provides a subcription's URL endpoint and allows unsubscription from a push service. Available only in secure contexts.

interface PushSubscription {
    endpoint: string;
    expirationTime: number;
    options: PushSubscriptionOptions;
    getKey(name: PushEncryptionKeyName): ArrayBuffer;
    toJSON(): PushSubscriptionJSON;
    unsubscribe(): Promise<boolean>;
}

Index

Properties

endpoint expirationTime options

Methods

getKey toJSON unsubscribe

Properties

`Readonly`endpoint

endpoint: string

`Readonly`expirationTime

expirationTime: number

`Readonly`options

options: PushSubscriptionOptions

Methods

getKey

getKey(name: PushEncryptionKeyName): ArrayBuffer
MDN Reference
Parameters
- name: PushEncryptionKeyName
Returns ArrayBuffer

toJSON

toJSON(): PushSubscriptionJSON
MDN Reference

Returns PushSubscriptionJSON

unsubscribe

unsubscribe(): Promise<boolean>
MDN Reference

Returns Promise<boolean>