Profile
public 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)Denotes that the UrlPrefetch API surface is experimental. |
Constants |
|
|---|---|
default static final String |
DEFAULT_PROFILE_NAME = "Default"Represents the name of the default profile which can't be deleted. |
Public methods |
|
|---|---|
abstract void |
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")Removes a cached prefetch response for the provided url if it exists, otherwise does nothing. |
abstract @NonNull CookieManager |
@AnyThreadReturns the profile's cookie manager. |
abstract @NonNull GeolocationPermissions |
@AnyThreadReturns the geolocation permissions of the profile. |
abstract @NonNull String |
@AnyThread |
abstract @NonNull ServiceWorkerController |
@AnyThreadReturns the service worker controller of the profile. |
abstract @NonNull WebStorage |
@AnyThreadReturns the profile's web storage. |
abstract void |
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")Starts a URL prefetch request. |
abstract void |
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")Starts a URL prefetch request. |
Constants
DEFAULT_PROFILE_NAME
default static final String DEFAULT_PROFILE_NAME = "Default"
Represents the name of the default profile which can't be deleted.
Public methods
clearPrefetchAsync
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@AnyThread
@Profile.ExperimentalUrlPrefetch
abstract void clearPrefetchAsync(
@NonNull String url,
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback
)
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 | |
|---|---|
@NonNull String url |
the url associated with the prefetch request. |
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback |
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
@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract @NonNull CookieManager getCookieManager()
Returns the profile's cookie manager.
Can be called from any thread.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the profile has been deleted by |
getGeolocationPermissions
@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract @NonNull GeolocationPermissions getGeolocationPermissions()
Returns the geolocation permissions of the profile.
Can be called from any thread.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the profile has been deleted by |
getName
@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract @NonNull String getName()
getServiceWorkerController
@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract @NonNull ServiceWorkerController getServiceWorkerController()
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 |
getWebStorage
@AnyThread
@RequiresFeature(name = WebViewFeature.MULTI_PROFILE, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
abstract @NonNull WebStorage getWebStorage()
Returns the profile's web storage.
Can be called from any thread.
| Throws | |
|---|---|
java.lang.IllegalStateException |
if the profile has been deleted by |
prefetchUrlAsync
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@AnyThread
@Profile.ExperimentalUrlPrefetch
abstract void prefetchUrlAsync(
@NonNull String url,
@Nullable CancellationSignal cancellationSignal,
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback
)
Starts a URL prefetch request. Can be called from any 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.
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.
All result callbacks will be resolved on the calling thread.
| Parameters | |
|---|---|
@NonNull String url |
the url associated with the prefetch request. |
@Nullable CancellationSignal cancellationSignal |
will make the best effort to cancel an in-flight prefetch request, However cancellation is not guaranteed. |
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback |
callbacks for reporting result back to application. |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the url or callback is null. |
prefetchUrlAsync
@RequiresFeature(name = WebViewFeature.PROFILE_URL_PREFETCH, enforcement = "androidx.webkit.WebViewFeature#isFeatureSupported")
@AnyThread
@Profile.ExperimentalUrlPrefetch
abstract void prefetchUrlAsync(
@NonNull String url,
@Nullable CancellationSignal cancellationSignal,
@NonNull SpeculativeLoadingParameters speculativeLoadingParameters,
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback
)
Starts a URL prefetch request. Can be called from any 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.
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.
All result callbacks will be resolved on the calling thread.
| Parameters | |
|---|---|
@NonNull String url |
the url associated with the prefetch request. |
@Nullable CancellationSignal cancellationSignal |
will make the best effort to cancel an in-flight prefetch request, However cancellation is not guaranteed. |
@NonNull SpeculativeLoadingParameters speculativeLoadingParameters |
parameters to customize the prefetch request. |
@NonNull OutcomeReceiverCompat<Void, PrefetchException> operationCallback |
callbacks for reporting result back to application. |
| Throws | |
|---|---|
java.lang.IllegalArgumentException |
if the url or callback is null. |