ServiceWorkerWebSettingsCompat

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_CONTENT_ACCESS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun getAllowContentAccess(): Boolean

Gets whether Service Workers support content URL access.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_CONTENT_ACCESS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_FILE_ACCESS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun getAllowFileAccess(): Boolean

Gets whether Service Workers support file access.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_FILE_ACCESS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_BLOCK_NETWORK_LOADS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun getBlockNetworkLoads(): Boolean

Gets whether Service Workers are prohibited from loading any resources from the network.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_BLOCK_NETWORK_LOADS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_CACHE_MODE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun getCacheMode(): Int

Gets the current setting for overriding the cache mode.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_CACHE_MODE.

@RequiresFeature(name = WebViewFeature.REQUESTED_WITH_HEADER_ALLOW_LIST, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun getRequestedWithHeaderOriginAllowList(): (Mutable)Set<String!>

Get the currently configured allow-list of origins, which is guaranteed to receive the X-Requested-With HTTP header on requests from service workers.

Any origin not on this allow-list may not receive the header, depending on the current installed WebView provider.

The format of the strings in the allow-list follows the origin rules of addWebMessageListener.

@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun isIncludeCookiesOnShouldInterceptRequestEnabled(): Boolean

Returns whether cookie access during request intercept is enabled.

This method should only be called if isFeatureSupported returns true for COOKIE_INTERCEPT.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_CONTENT_ACCESS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setAllowContentAccess(allow: Boolean): Unit

Enables or disables content URL access from Service Workers.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_CONTENT_ACCESS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_FILE_ACCESS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setAllowFileAccess(allow: Boolean): Unit

Enables or disables file access within Service Workers.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_FILE_ACCESS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_BLOCK_NETWORK_LOADS, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setBlockNetworkLoads(flag: Boolean): Unit

Sets whether Service Workers should not load resources from the network.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_BLOCK_NETWORK_LOADS.

@RequiresFeature(name = WebViewFeature.SERVICE_WORKER_CACHE_MODE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setCacheMode(mode: Int): Unit

Overrides the way the cache is used.

This method should only be called if isFeatureSupported returns true for SERVICE_WORKER_CACHE_MODE.

@RequiresFeature(name = WebViewFeature.COOKIE_INTERCEPT, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setIncludeCookiesOnShouldInterceptRequestEnabled(enabled: Boolean): Unit

This method controls if the relevant Cookie header will be added to the WebResourceRequest object passed to shouldInterceptRequest. It also enables the use of setCookies, which will otherwise be ignored.

Prefer using this method over calling CookieManager as part of intercepting requests if it is necessary to access cookies, as this approach will provide the correct set of cookies for the request.

This method should only be called if isFeatureSupported returns true for COOKIE_INTERCEPT.

@RequiresFeature(name = WebViewFeature.REQUESTED_WITH_HEADER_ALLOW_LIST, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract fun setRequestedWithHeaderOriginAllowList(allowList: (Mutable)Set<String!>): Unit

Set an allow-list of origins to receive the X-Requested-With HTTP header from service workers.

Historically, this header was sent on all requests from WebView, containing the app package name of the embedding app. Depending on the version of installed WebView, this may no longer be the case, as the header was deprecated in late 2022, and its use discontinued.

Apps can use this method to restore the legacy behavior for servers that still rely on the deprecated header, but it should not be used to identify the WebView to first-party servers under the control of the app developer.

The format of the strings in the allow-list follows the origin rules of addWebMessageListener.