ProcessGlobalConfig

ProcessGlobalConfig()

Creates a ProcessGlobalConfig object.

java-static fun apply(config: ProcessGlobalConfig): Unit

Applies the configuration to be used by WebView on loading.

This method can only be called once.

Calling this method will not cause WebView to be loaded and will not block the calling thread.

@RequiresFeature(name = WebViewFeature.STARTUP_FEATURE_SET_DATA_DIRECTORY_SUFFIX, enforcement = "androidx.webkit.WebViewFeature#isConfigFeatureSupported(String, Context)")
fun setDataDirectorySuffix(context: Context, suffix: String): ProcessGlobalConfig

Define the directory used to store WebView data for the current process.

The provided suffix will be used when constructing data and cache directory paths. If this API is not called, no suffix will be used. Each directory can be used by only one process in the application. If more than one process in an app wishes to use WebView, only one process can use the default directory, and other processes must call this API to define a unique suffix.

This means that different processes in the same application cannot directly share WebView-related data, since the data directories must be distinct. Applications that use this API may have to explicitly pass data between processes. For example, login cookies may have to be copied from one process's cookie jar to the other using android.webkit.CookieManager if both processes' WebViews are intended to be logged in.

Most applications should simply ensure that all components of the app that rely on WebView are in the same process, to avoid needing multiple data directories. The disableWebView method can be used to ensure that the other processes do not use WebView by accident in this case.

This is a compatibility method for setDataDirectorySuffix

@RequiresFeature(name = WebViewFeature.STARTUP_FEATURE_SET_DIRECTORY_BASE_PATHS, enforcement = "androidx.webkit.WebViewFeature#isConfigFeatureSupported(String, Context)")
fun setDirectoryBasePaths(
    context: Context,
    dataDirectoryBasePath: File,
    cacheDirectoryBasePath: File
): ProcessGlobalConfig

Set the base directories that WebView will use for the current process.

If this method is not used, WebView uses the default base paths defined by the Android framework.

WebView will create and use a subdirectory under each of the base paths supplied to this method.

This method can be used in conjunction with setDataDirectorySuffix. A different subdirectory is created for each suffix.

The base paths must be absolute paths.

The data directory must not be under the Android cache directory, as Android may delete cache files when disk space is low and WebView may not function properly if this occurs. Refer to this link.

If the specified directories already exist then they must be readable and writable by the current process. If they do not already exist, WebView will attempt to create them during initialization, along with any missing parent directories. In such a case, the directory in which WebView creates missing directories must be readable and writable by the current process.