Stay organized with collections
Save and categorize content based on your preferences.
@WebViewCompat.ExperimentalAsyncStartUp
class WebViewStartUpConfig
Configuration object for startUpWebView.
This is different from ProcessGlobalConfig. This object defines the configuration for a particular call to startUpWebView.
Summary
Public functions |
Executor |
|
(Mutable)Set<String!>? |
Returns the Set of profiles to be loaded during the UI thread blocking parts of WebView startup.
|
Boolean |
Whether to run only parts of startup that doesn't block the UI thread.
|
Public functions
shouldRunUiThreadStartUpTasks
fun shouldRunUiThreadStartUpTasks(): Boolean
Whether 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 \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) \nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0)\n\n*** ** * ** ***\n\nKotlin \\|[Java](/reference/androidx/webkit/WebViewStartUpConfig \"View this page in Java\")\n\n\n```\n@WebViewCompat.ExperimentalAsyncStartUp\nclass WebViewStartUpConfig\n```\n\n\u003cbr /\u003e\n\n*** ** * ** ***\n\nConfiguration object for [startUpWebView](/reference/kotlin/androidx/webkit/WebViewCompat#startUpWebView(android.content.Context,androidx.webkit.WebViewStartUpConfig,androidx.webkit.WebViewCompat.WebViewStartUpCallback)).\n\nThis is different from [ProcessGlobalConfig](/reference/kotlin/androidx/webkit/ProcessGlobalConfig). This object defines the configuration for a particular call to [startUpWebView](/reference/kotlin/androidx/webkit/WebViewCompat#startUpWebView(android.content.Context,androidx.webkit.WebViewStartUpConfig,androidx.webkit.WebViewCompat.WebViewStartUpCallback)).\n\nSummary \n\n| Nested types |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `@`[WebViewCompat.ExperimentalAsyncStartUp](/reference/kotlin/androidx/webkit/WebViewCompat.ExperimentalAsyncStartUp) `class `[WebViewStartUpConfig.Builder](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder) |\n\n| Public functions |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| [Executor](https://developer.android.com/reference/java/util/concurrent/Executor.html) | [getBackgroundExecutor](/reference/kotlin/androidx/webkit/WebViewStartUpConfig#getBackgroundExecutor())`()` |\n| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)`)`[Set](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html)`\u003c`[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!\u003e?` | [getProfilesToLoadDuringStartup](/reference/kotlin/androidx/webkit/WebViewStartUpConfig#getProfilesToLoadDuringStartup())`()` Returns the [Set](https://developer.android.com/reference/java/util/Set.html) of profiles to be loaded during the UI thread blocking parts of WebView startup. |\n| [Boolean](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html) | [shouldRunUiThreadStartUpTasks](/reference/kotlin/androidx/webkit/WebViewStartUpConfig#shouldRunUiThreadStartUpTasks())`()` Whether to run only parts of startup that doesn't block the UI thread. |\n\nPublic functions \n\ngetBackgroundExecutor \nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0) \n\n```\nfun getBackgroundExecutor(): Executor\n``` \n\ngetProfilesToLoadDuringStartup \nAdded in [1.15.0-alpha02](/jetpack/androidx/releases/webkit#1.15.0-alpha02) \n\n```\nfun getProfilesToLoadDuringStartup(): (Mutable)Set\u003cString!\u003e?\n```\n\nReturns the [Set](https://developer.android.com/reference/java/util/Set.html) of profiles to be loaded during the UI thread blocking parts of WebView startup.\n\nFor more details on the behavior of this setting, see the documentation for [setProfilesToLoadDuringStartup](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder#setProfilesToLoadDuringStartup(java.util.Set\u003cjava.lang.String\u003e)). \n\n| Returns |\n|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------|\n| `(`[Mutable](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-mutable-set/index.html)`)`[Set](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-set/index.html)`\u003c`[String](https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html)`!\u003e?` | A [Set](https://developer.android.com/reference/java/util/Set.html) of profiles to be loaded, or `null` if this configuration setting is not active. |\n\n| See also |\n|------------------------------------------------------------------------------------------------------------------------------------------------------------------|---|\n| [setProfilesToLoadDuringStartup](/reference/kotlin/androidx/webkit/WebViewStartUpConfig.Builder#setProfilesToLoadDuringStartup(java.util.Set\u003cjava.lang.String\u003e)) | |\n\nshouldRunUiThreadStartUpTasks \nAdded in [1.13.0](/jetpack/androidx/releases/webkit#1.13.0) \n\n```\nfun shouldRunUiThreadStartUpTasks(): Boolean\n```\n\nWhether 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."]]
