PrefetchCache

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun clearMaxPrefetches(): Unit

Resets the maximum number of prefetches for the current browsing session to system default.

This configuration will be applied to any prefetch requests made after they are set; they will not be applied to in-flight requests.

This configuration will be applied to WebViews that are associated with the Profile that owns this PrefetchCache.

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

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun clearPrefetchTtl(): Unit

Resets the maximum prefetch Time-to-Live (TTL) in seconds for the current browsing session to the system default.

This configuration will be applied to any prefetch requests made after they are set; they will not be applied to in-flight requests.

This configuration will be applied to WebViews that are associated with the Profile that owns this PrefetchCache.

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

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun getMaxPrefetches(): Int

Returns maximum prefetches set for this Profile.

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

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun getPrefetchTtlSeconds(): Int

Returns Prefetch TTL in Seconds set for this Profile.

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

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

Starts a URL prefetch request.

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.

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

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

Starts a URL prefetch request.

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.

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

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun setMaxPrefetches(maxPrefetches: @IntRange(from = 1) Int): Unit

Sets the maximum number of prefetches for the current browsing session.

This configuration will be applied to any prefetch requests made after they are set; they will not be applied to in-flight requests.

This configuration will be applied to WebViews that are associated with the Profile that owns this PrefetchCache.

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

@RequiresFeature(name = WebViewFeature.PREFETCH_CACHE_V1, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@UiThread
@Profile.ExperimentalUrlPrefetch
fun setPrefetchTtlSeconds(prefetchTtlSeconds: @IntRange(from = 1) Int): Unit

Sets the maximum prefetch Time-to-Live (TTL) in seconds for the current browsing 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 WebViews that are associated with the Profile that owns this PrefetchCache.

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