# ServiceWorkerControllerCompat

Artifact: [androidx.webkit:webkit](https://developer.android.com/jetpack/androidx/releases/webkit) [View Source](https://cs.android.com/search?q=file:androidx/webkit/ServiceWorkerControllerCompat.java+class:androidx.webkit.ServiceWorkerControllerCompat) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.1.0)

*** ** * ** ***


```
@AnyThread
public abstract class ServiceWorkerControllerCompat
```

<br />

*** ** * ** ***

Manages Service Workers used by WebView.

Example usage:

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

## Summary

| ### Public methods |
|---|---|
| `static @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/webkit/ServiceWorkerControllerCompat` | `@https://developer.android.com/reference/androidx/annotation/RequiresFeature(name = https://developer.android.com/reference/androidx/webkit/WebViewFeature.SERVICE_WORKER_BASIC_USAGE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") https://developer.android.com/reference/androidx/webkit/ServiceWorkerControllerCompat#getInstance()()` Returns the default ServiceWorkerController instance. |
| `abstract @https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/webkit/ServiceWorkerWebSettingsCompat` | `https://developer.android.com/reference/androidx/webkit/ServiceWorkerControllerCompat#getServiceWorkerWebSettings()()` Gets the settings for all service workers. |
| `abstract void` | `https://developer.android.com/reference/androidx/webkit/ServiceWorkerControllerCompat#setServiceWorkerClient(androidx.webkit.ServiceWorkerClientCompat)(@https://jspecify.dev/docs/api/org/jspecify/annotations/Nullable.html https://developer.android.com/reference/androidx/webkit/ServiceWorkerClientCompat client)` Sets the client to capture service worker related callbacks. |

## Public methods

### getInstance

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.1.0)

```
@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_BASIC_USAGE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
public static @NonNull ServiceWorkerControllerCompat 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 |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/webkit/ServiceWorkerControllerCompat` | the default ServiceWorkerController instance |

| Throws |
|---|---|
| `https://developer.android.com/reference/java/lang/UnsupportedOperationException.html` | if the `https://developer.android.com/reference/androidx/webkit/WebViewFeature#SERVICE_WORKER_BASIC_USAGE()` feature is not supported. This should be checked before use with `https://developer.android.com/reference/androidx/webkit/WebViewFeature#isFeatureSupported(java.lang.String)`. |

### getServiceWorkerWebSettings

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.1.0)

```
public abstract @NonNull ServiceWorkerWebSettingsCompat getServiceWorkerWebSettings()
```

Gets the settings for all service workers.

| Returns |
|---|---|
| `@https://jspecify.dev/docs/api/org/jspecify/annotations/NonNull.html https://developer.android.com/reference/androidx/webkit/ServiceWorkerWebSettingsCompat` | the current `https://developer.android.com/reference/androidx/webkit/ServiceWorkerWebSettingsCompat` |

### setServiceWorkerClient

Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/webkit#1.1.0)

```
public abstract void setServiceWorkerClient(@Nullable ServiceWorkerClientCompat client)
```

Sets the client to capture service worker related callbacks.

A `https://developer.android.com/reference/androidx/webkit/ServiceWorkerClientCompat` should be set before any service workers are active, e.g. a safe place is before any WebView instances are created or pages loaded.