Package org.mozilla.geckoview

Interface WebPushDelegate

public interface WebPushDelegate

Delegate for handling web push subscription events.

Method Summary

Modifier and Type	Method	Description
default GeckoResult<WebPushSubscription>	onGetSubscription(String scope)	Retrieves a subscription for the given service worker scope.
default GeckoResult<WebPushSubscription>	onSubscribe(String scope, byte[] appServerKey)	Creates a push subscription for the given service worker scope.
default GeckoResult<Void>	onUnsubscribe(String scope)	Removes a push subscription.

Method Details

onSubscribe

@UiThread
@Nullable
default GeckoResult<WebPushSubscription> onSubscribe(@NonNull
 String scope,
 @Nullable
 byte[] appServerKey)

Creates a push subscription for the given service worker scope. A scope uniquely identifies a service worker. `appServerKey` optionally creates a restricted subscription.

Applications will likely want to persist the returned WebPushSubscription in order to support onGetSubscription(String).

Parameters:

scope - The Service Worker scope.

appServerKey - An optional application server key.

Returns:

A GeckoResult which resolves to a WebPushSubscription

See Also:

• subscribe()
• Application server key

onGetSubscription

@UiThread
@Nullable
default GeckoResult<WebPushSubscription> onGetSubscription(@NonNull
 String scope)

Retrieves a subscription for the given service worker scope.

Parameters:

scope - The scope for the requested WebPushSubscription.

Returns:

A GeckoResult which resolves to a WebPushSubscription

See Also:

• getSubscription()

onUnsubscribe

@UiThread
@Nullable
default GeckoResult<Void> onUnsubscribe(@NonNull
 String scope)

Removes a push subscription. If this fails, apps should resolve the returned GeckoResult with an exception.

Parameters:

scope - The Service Worker scope for the subscription.

Returns:

A GeckoResult, which if non-exceptional indicates successfully unsubscribing.

See Also:

• unsubscribe()