Source code
Revision control
Copy as Markdown
Other Tools
/* -*- Mode: Java; c-basic-offset: 4; tab-width: 20; indent-tabs-mode: nil; -*-
* vim: ts=4 sw=4 expandtab:
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
package org.mozilla.geckoview;
import androidx.annotation.NonNull;
import androidx.annotation.Nullable;
import androidx.annotation.UiThread;
public interface WebPushDelegate {
/**
* Creates a push subscription for the given service worker scope. A scope uniquely identifies a
* service worker. `appServerKey` optionally creates a restricted subscription.
*
* <p>Applications will likely want to persist the returned {@link WebPushSubscription} in order
* to support {@link #onGetSubscription(String)}.
*
* @param scope The Service Worker scope.
* @param appServerKey An optional application server key.
* @return A {@link GeckoResult} which resolves to a {@link WebPushSubscription}
* @see <a
* href="http://w3c.github.io/push-api/#dom-pushsubscriptionoptionsinit-applicationserverkey">Application
* server key</a>
*/
@UiThread
default @Nullable GeckoResult<WebPushSubscription> onSubscribe(
@NonNull final String scope, @Nullable final byte[] appServerKey) {
return null;
}
/**
* Retrieves a subscription for the given service worker scope.
*
* @param scope The scope for the requested {@link WebPushSubscription}.
* @return A {@link GeckoResult} which resolves to a {@link WebPushSubscription}
* @see <a
*/
@UiThread
default @Nullable GeckoResult<WebPushSubscription> onGetSubscription(
@NonNull final String scope) {
return null;
}
/**
* Removes a push subscription. If this fails, apps should resolve the returned {@link
* GeckoResult} with an exception.
*
* @param scope The Service Worker scope for the subscription.
* @return A {@link GeckoResult}, which if non-exceptional indicates successfully unsubscribing.
* @see <a
*/
@UiThread
default @Nullable GeckoResult<Void> onUnsubscribe(@NonNull final String scope) {
return null;
}
}