Profile

Artifact: androidx.webkit:webkit

View Source

Added in 1.9.0

---

Kotlin |Java

interface Profile

---

A Profile represents one browsing session for WebView.

You can have multiple profiles and each profile holds its own set of data. The creation and deletion of the Profile is being managed by ProfileStore.

Summary

Nested types
@Retention(value = RetentionPolicy.CLASS) @Target(value = [ElementType.METHOD, ElementType.TYPE, ElementType.FIELD]) @RequiresOptIn(level = RequiresOptIn.Level.ERROR) annotation Profile.ExperimentalUrlPrefetch Denotes that the UrlPrefetch API surface is experimental.

Constants
const String!	DEFAULT_PROFILE_NAME = "Default" Represents the name of the default profile which can't be deleted.

Public functions
Unit	@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") @UiThread @Profile.ExperimentalUrlPrefetch clearPrefetchAsync(     url: String,     callbackExecutor: Executor,     operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!> ) Removes a cached prefetch response for the provided url if it exists, otherwise does nothing.
CookieManager	@AnyThread @RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") getCookieManager() Returns the profile's cookie manager.
GeolocationPermissions	@AnyThread @RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") getGeolocationPermissions() Returns the geolocation permissions of the profile.
String	@AnyThread @RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") getName()
ServiceWorkerController	@AnyThread @RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") getServiceWorkerController() Returns the service worker controller of the profile.
WebStorage	@AnyThread @RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") getWebStorage() Returns the profile's web storage.
Unit	@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") @UiThread @Profile.ExperimentalUrlPrefetch prefetchUrlAsync(     url: String,     cancellationSignal: CancellationSignal?,     callbackExecutor: Executor,     operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!> ) Starts a URL prefetch request.
Unit	@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") @UiThread @Profile.ExperimentalUrlPrefetch prefetchUrlAsync(     url: String,     cancellationSignal: CancellationSignal?,     callbackExecutor: Executor,     speculativeLoadingParameters: SpeculativeLoadingParameters,     operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!> ) Starts a URL prefetch request.
Unit	@RequiresFeature(name = WebViewFeature.SPECULATIVE_LOADING_CONFIG, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported") @UiThread @Profile.ExperimentalUrlPrefetch setSpeculativeLoadingConfig(     speculativeLoadingConfig: SpeculativeLoadingConfig ) Sets the SpeculativeLoadingConfig for the current profile session.

Constants

DEFAULT_PROFILE_NAME

Added in 1.9.0

const val DEFAULT_PROFILE_NAME = "Default": String!

Represents the name of the default profile which can't be deleted.

Public functions

clearPrefetchAsync

Added in 1.13.0

@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun clearPrefetchAsync(
    url: String,
    callbackExecutor: Executor,
    operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>
): Unit

Removes a cached prefetch response for the provided url if it exists, otherwise does nothing.

Calling this does not guarantee that the prefetched response will not be served to a WebView before it is cleared.

Parameters
url: String	the url associated with the prefetch request. Should be an exact match with the URL passed to prefetchUrlAsync.
callbackExecutor: Executor	the executor to resolve the callback with.
operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>	runs when the clear operation is complete Or and error occurred during it.

Throws
java.lang.IllegalArgumentException	if the url or callback is null.

getCookieManager

Added in 1.9.0

@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun getCookieManager(): CookieManager

Returns the profile's cookie manager.

Can be called from any thread.

Throws
java.lang.IllegalStateException	if the profile has been deleted by deleteProfile}.

getGeolocationPermissions

Added in 1.9.0

@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun getGeolocationPermissions(): GeolocationPermissions

Returns the geolocation permissions of the profile.

Can be called from any thread.

Throws
java.lang.IllegalStateException	if the profile has been deleted by deleteProfile}.

getName

Added in 1.9.0

@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun getName(): String

Returns
String	the name of this Profile which was used to create the Profile from ProfileStore create methods.

getServiceWorkerController

Added in 1.9.0

@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun getServiceWorkerController(): ServiceWorkerController

Returns the service worker controller of the profile.

Can be called from any thread.

Throws
java.lang.IllegalStateException	if the profile has been deleted by deleteProfile}.

getWebStorage

Added in 1.9.0

@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
fun getWebStorage(): WebStorage

Returns the profile's web storage.

Can be called from any thread.

Throws
java.lang.IllegalStateException	if the profile has been deleted by deleteProfile}.

prefetchUrlAsync

Added in 1.13.0

@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun prefetchUrlAsync(
    url: String,
    cancellationSignal: CancellationSignal?,
    callbackExecutor: Executor,
    operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>
): Unit

Starts a URL prefetch request. Must be called from the UI thread.

All WebViews associated with this Profile will use a URL request matching algorithm during execution of all variants of loadUrl for determining if there was already a prefetch request executed for the provided URL. This includes prefetches that are "in progress". If a prefetch is matched, WebView will leverage that for handling the URL, otherwise the URL will be handled normally (i.e. through a network request).

Applications will still be responsible for calling loadUrl to display web contents in a WebView.

NOTE: Additional headers passed to loadUrl are not considered in the matching algorithm for determining whether or not to serve a prefetched response to a navigation.

For max latency saving benefits, it is recommended to call this method as early as possible (i.e. before any WebView associated with this profile is created).

Only supports HTTPS scheme.

Parameters
url: String	the url associated with the prefetch request.
cancellationSignal: CancellationSignal?	will make the best effort to cancel an in-flight prefetch request, However cancellation is not guaranteed.
callbackExecutor: Executor	the executor to resolve the callback with.
operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>	callbacks for reporting result back to application.

Throws
java.lang.IllegalArgumentException	if the url or callback is null.

prefetchUrlAsync

Added in 1.13.0

@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun prefetchUrlAsync(
    url: String,
    cancellationSignal: CancellationSignal?,
    callbackExecutor: Executor,
    speculativeLoadingParameters: SpeculativeLoadingParameters,
    operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>
): Unit

Starts a URL prefetch request. Must be called from the UI thread.

All WebViews associated with this Profile will use a URL request matching algorithm during execution of all variants of loadUrl for determining if there was already a prefetch request executed for the provided URL. This includes prefetches that are "in progress". If a prefetch is matched, WebView will leverage that for handling the URL, otherwise the URL will be handled normally (i.e. through a network request).

Applications will still be responsible for calling loadUrl to display web contents in a WebView.

NOTE: Additional headers passed to loadUrl are not considered in the matching algorithm for determining whether or not to serve a prefetched response to a navigation.

For max latency saving benefits, it is recommended to call this method as early as possible (i.e. before any WebView associated with this profile is created).

Only supports HTTPS scheme.

Parameters
url: String	the url associated with the prefetch request.
cancellationSignal: CancellationSignal?	will make the best effort to cancel an in-flight prefetch request, However cancellation is not guaranteed.
callbackExecutor: Executor	the executor to resolve the callback with.
speculativeLoadingParameters: SpeculativeLoadingParameters	parameters to customize the prefetch request.
operationCallback: OutcomeReceiverCompat<Void!, PrefetchException!>	callbacks for reporting result back to application.

Throws
java.lang.IllegalArgumentException	if the url or callback is null.

setSpeculativeLoadingConfig

Added in 1.13.0

@RequiresFeature(name = WebViewFeature.SPECULATIVE_LOADING_CONFIG, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun setSpeculativeLoadingConfig(
    speculativeLoadingConfig: SpeculativeLoadingConfig
): Unit

Sets the SpeculativeLoadingConfig for the current profile session. These configurations will be applied to any Prefetch requests made after they are set; they will not be applied to in-flight requests.

These configurations will be applied to any prefetch requests initiated by a prerender request. This applies specifically to WebViews that are associated with this Profile.

Parameters
speculativeLoadingConfig: SpeculativeLoadingConfig	the config to set for this profile session.