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: null | number;
    options: PushSubscriptionOptions;
    getKey(name: PushEncryptionKeyName): null | ArrayBuffer;
    toJSON(): PushSubscriptionJSON;
    unsubscribe(): Promise<boolean>;
}

Index

Properties

endpoint expirationTime options

Methods

getKey toJSON unsubscribe

Properties

`Readonly`endpoint

endpoint: string

`Readonly`expirationTime

expirationTime: null | number

`Readonly`options

options: PushSubscriptionOptions

Methods

getKey

getKey(name: PushEncryptionKeyName): null | ArrayBuffer
MDN Reference
Parameters
- name: PushEncryptionKeyName
Returns null | ArrayBuffer
- Defined in node_modules/typescript/lib/lib.dom.d.ts:18810

toJSON

toJSON(): PushSubscriptionJSON
MDN Reference

Returns PushSubscriptionJSON
- Defined in node_modules/typescript/lib/lib.dom.d.ts:18812

unsubscribe

unsubscribe(): Promise<boolean>
MDN Reference

Returns Promise<boolean>
- Defined in node_modules/typescript/lib/lib.dom.d.ts:18814