PrefetchParameters.Builder

public Builder()

Construct a new Builder.

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder addAdditionalHeader(@NonNull String key, @NonNull String value)

Sets the header value for the given key. If called multiple times for the same key, the last value will be used.

Header keys must be RFC 2616 compliant.

The logic for handling additional header isn't guaranteed to match the loadUrl's logic and is subject to change in the future.

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder addAdditionalHeaders(@NonNull Map<String, String> additionalHeaders)

Sets multiple headers at once. The headers passed in here will be merged with any that have been previously set (duplicate keys will be overridden).

Header keys must be RFC 2616 -compliant.

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters build()

Build the PrefetchParameters.

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder setExpectedNoVarySearchData(
    @NonNull NoVarySearchHeader expectedNoVarySearchHeader
)

Sets the No-Vary-Search data that's expected to be returned via the header in the prefetch's response.

This is used to help determine if WebView#loadUrl should either use an in-flight prefetch response to render the web contents or handle the URL as it typically does (i.e. start a network request).

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder setExpectedNoVarySearchHeader(
    @NonNull NoVarySearchHeader expectedNoVarySearchHeader
)

Sets the No-Vary-Search data that's expected to be returned via the header in the prefetch's response.

This is used to help determine if WebView#loadUrl should either use an in-flight prefetch response to render the web contents or handle the URL as it typically does (i.e. start a network request).

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder setJavaScriptEnabled(boolean javaScriptEnabled)

Set whether the page that is loaded will have JavaScript enabled. true if the WebView's that will be loading the prefetched response will have javascript enabled. This affects whether client hints header is sent with the prefetch request.

@Profile.ExperimentalUrlPrefetch
public @NonNull PrefetchParameters.Builder setVariationsId(@Nullable Integer variationsId)

Sets an optional variations ID to associate with this prefetch request.