akasha

Class PushSubscription

java.lang.Object

akasha.core.JsObject

akasha.PushSubscription

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="PushSubscription")
public class PushSubscription
extends JsObject

The PushSubscription interface of the Push API provides a subcription's URL endpoint and allows unsubscription from a push service.

See Also:

PushSubscription - MDN, PushSubscription - Push API

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PushSubscription()

Method Summary

Modifier and Type	Method and Description
java.lang.String	endpoint() The endpoint read-only property of the PushSubscription interface returns a USVString containing the endpoint associated with the push subscription.
int	expirationTime() The expirationTime read-only property of the PushSubscription interface returns a DOMHighResTimeStamp of the subscription expiration time associated with the push subscription, if there is one, or null otherwise.
ArrayBuffer	getKey(java.lang.String name) The getKey() method of the PushSubscription interface returns an ArrayBuffer representing a client public key, which can then be sent to a server and used in encrypting push message data.
PushSubscriptionOptions	options() The options read-only property of the PushSubscription interface is an object containing containing the options used to create the subscription.
PushSubscriptionJSON	toJSON() The toJSON() method of the PushSubscription interface is a standard serializer: it returns a JSON representation of the subscription properties, providing a useful shortcut.
Promise<java.lang.Boolean>	unsubscribe() The unsubscribe() method of the PushSubscription interface returns a Promise that resolves to a Boolean when the current subscription is successfully unsubscribed.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PushSubscription

protected PushSubscription()

Method Detail

endpoint

@JsProperty(name="endpoint")
 @Nonnull
public java.lang.String endpoint()

The endpoint read-only property of the PushSubscription interface returns a USVString containing the endpoint associated with the push subscription.

See Also:

PushSubscription.endpoint - MDN, endPoint - Push API

expirationTime

@JsProperty(name="expirationTime")
 @Nullable
public int expirationTime()

The expirationTime read-only property of the PushSubscription interface returns a DOMHighResTimeStamp of the subscription expiration time associated with the push subscription, if there is one, or null otherwise.

See Also:

PushSubscription.expirationTime - MDN, expirationTime - Push API

options

@JsProperty(name="options")
 @Nonnull
public PushSubscriptionOptions options()

The options read-only property of the PushSubscription interface is an object containing containing the options used to create the subscription.

See Also:

PushSubscription.options - MDN, options - Push API

getKey

@Nullable
public ArrayBuffer getKey(@PushEncryptionKeyName @Nonnull
                                    java.lang.String name)

The getKey() method of the PushSubscription interface returns an ArrayBuffer representing a client public key, which can then be sent to a server and used in encrypting push message data.

See Also:

PushSubscription.getKey - MDN, Push API

toJSON

@Nonnull
public PushSubscriptionJSON toJSON()

The toJSON() method of the PushSubscription interface is a standard serializer: it returns a JSON representation of the subscription properties, providing a useful shortcut.

See Also:

PushSubscription.toJSON - MDN, PushSubscription: toJSON - Push API

unsubscribe

@Nonnull
public Promise<java.lang.Boolean> unsubscribe()

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

See Also:

PushSubscription.unsubscribe - MDN, unsubscribe() - Push API