lightbulb_outline Please take our October 2018 developer survey. Start survey

ServiceWorkerController

public abstract class ServiceWorkerController
extends Object

java.lang.Object
   ↳ android.webkit.ServiceWorkerController


Manages Service Workers used by WebView.

Example usage:

 ServiceWorkerController swController = ServiceWorkerController.getInstance();
 swController.setServiceWorkerClient(new ServiceWorkerClient() {
   @Override
   public WebResourceResponse shouldInterceptRequest(WebResourceRequest request) {
     // Capture request here and generate response or allow pass-through
     // by returning null.
     return null;
   }
 });
 

Summary

Public constructors

ServiceWorkerController()

Public methods

static ServiceWorkerController getInstance()

Returns the default ServiceWorkerController instance.

abstract ServiceWorkerWebSettings getServiceWorkerWebSettings()

Gets the settings for all service workers.

abstract void setServiceWorkerClient(ServiceWorkerClient client)

Sets the client to capture service worker related callbacks.

Inherited methods

Public constructors

ServiceWorkerController

added in API level 24
public ServiceWorkerController ()

Public methods

getInstance

added in API level 24
public static ServiceWorkerController getInstance ()

Returns the default ServiceWorkerController instance. At present there is only one ServiceWorkerController instance for all WebView instances, however this restriction may be relaxed in the future.

Returns
ServiceWorkerController the default ServiceWorkerController instance

This value will never be null.

getServiceWorkerWebSettings

added in API level 24
public abstract ServiceWorkerWebSettings getServiceWorkerWebSettings ()

Gets the settings for all service workers.

Returns
ServiceWorkerWebSettings the current ServiceWorkerWebSettings

This value will never be null.

setServiceWorkerClient

added in API level 24
public abstract void setServiceWorkerClient (ServiceWorkerClient client)

Sets the client to capture service worker related callbacks. A ServiceWorkerClient should be set before any service workers are active, e.g. a safe place is before any WebView instances are created or pages loaded.

Parameters
client ServiceWorkerClient

This value may be null.