Stay organized with collections
Save and categorize content based on your preferences.
@WebViewCompat.ExperimentalAsyncStartUp
class WebViewStartUpConfig.Builder
Summary
Public constructors
Builder(executor: Executor)
Builder for WebViewStartUpConfig.
| Parameters |
executor: Executor |
The portions of WebView startup that can run on a background thread are scheduled on this executor. Blocking tasks will be run on the executor.
|
Public functions
setProfilesToLoadDuringStartup
fun setProfilesToLoadDuringStartup(profiles: (Mutable)Set<String!>): WebViewStartUpConfig.Builder
Specifies a set of profiles to load before the startup callback is invoked.
This method allows you to specify a set of profiles that are guaranteed to have been loaded before the WebViewCompat.WebViewStartUpCallback is invoked. This can improve the performance of subsequent operations on those profiles at the cost of increasing the initial startup time.
Any profiles not specified in the set will not have resources allocated for them until they are used for the first time.
The behavior depends on the value provided:
- Empty Set: No profiles are loaded, not even the default profile.
- Non-empty Set: All profiles named in the set are loaded. These profiles will be created if they do not already exist.
If this method isn't called, the default profile will be loaded during startup.
Note: This method cannot be used if setShouldRunUiThreadStartUpTasks is set to false.
This method will be no-op if isStartupFeatureSupported returns false for STARTUP_FEATURE_SET_PROFILES_TO_LOAD.
| Parameters |
profiles: (Mutable)Set<String!> |
A Set of profile names to pre-load or an empty Set to load none.
|
setShouldRunUiThreadStartUpTasks
fun setShouldRunUiThreadStartUpTasks(
shouldRunUiThreadStartUpTasks: Boolean
): WebViewStartUpConfig.Builder
Setter to run only parts of startup that doesn't block the UI thread.
WebView startup tasks that are required to run on the UI thread are not attempted when startUpWebView is called if set to false.
Defaults to `true`. If not set to `false`, UI thread startup tasks will be run.
Content and code samples on this page are subject to the licenses described in the Content License. Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
Last updated 2025-08-27 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-08-27 UTC."],[],[],null,["# WebViewStartUpConfig.Builder\n============================\n\nArtifact: [androidx.webkit:webkit](/jetpack/androidx/releases/webkit) \n[View Source](https://cs.android.com/search?q=file:androidx/webkit/WebViewStartUpConfig.java+class:androidx.webkit.WebViewStartUpConfig.Builder) \nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0)\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/androidx/webkit/WebViewStartUpConfig.Builder \"View this page in Java\")\n\n\n```\n@WebViewCompat.ExperimentalAsyncStartUp\nclass WebViewStartUpConfig.Builder\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nSummary\n-------\n\n| ### Public constructors |\n|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Builder](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder#Builder(java.util.concurrent.Executor))`(executor: `[Executor](https://developer.android.com/reference/java/util/concurrent/Executor.html)`)` Builder for [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig). |\n\n| ### Public functions |\n|------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig) | [build](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder#build())`()` Build and return a [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig) object. |\n| [WebViewStartUpConfig.Builder](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder) | [setShouldRunUiThreadStartUpTasks](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder#setShouldRunUiThreadStartUpTasks(boolean))`(` ` shouldRunUiThreadStartUpTasks: `[Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) `)` Setter to run only parts of startup that doesn't block the UI thread. |\n\nPublic constructors\n-------------------\n\n### Builder\n\nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0) \n\n```\nBuilder(executor: Executor)\n```\n\nBuilder for [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig). \n\n| Parameters |\n|----------------------------------------------------------------------------------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------|\n| `executor: `[Executor](https://developer.android.com/reference/java/util/concurrent/Executor.html) | The portions of WebView startup that can run on a background thread are scheduled on this executor. Blocking tasks will be run on the executor. |\n\nPublic functions\n----------------\n\n### build\n\nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0) \n\n```\nfun build(): WebViewStartUpConfig\n```\n\nBuild and return a [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig) object. \n\n| Returns |\n|--------------------------------------------------------------------------------|--------------------------------------------------------------------------------------------------|\n| [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig) | immutable [WebViewStartUpConfig](/reference/kotlin/androidx/webkit/WebViewStartUpConfig) object. |\n\n### setShouldRunUiThreadStartUpTasks\n\nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0) \n\n```\nfun setShouldRunUiThreadStartUpTasks(\n shouldRunUiThreadStartUpTasks: Boolean\n): WebViewStartUpConfig.Builder\n```\n\nSetter to run only parts of startup that doesn't block the UI thread.\n\nWebView startup tasks that are required to run on the UI thread are not attempted when [startUpWebView](/reference/kotlin/androidx/webkit/WebViewCompat#startUpWebView(android.content.Context,androidx.webkit.WebViewStartUpConfig,androidx.webkit.WebViewCompat.WebViewStartUpCallback)) is called if set to `false`.\n\nDefaults to \\`true\\`. If not set to \\`false\\`, UI thread startup tasks will be run."]]
