chrome-devtools-kotlin/org.hildan.chrome.devtools.domains.pwa/PWADomain

PWADomain

This domain allows interacting with the browser to control PWAs.

Functions

suspend fun changeAppUserSettings(input: ChangeAppUserSettingsRequest): ChangeAppUserSettingsResponse

inline suspend fun changeAppUserSettings(manifestId: String, optionalArgs: ChangeAppUserSettingsRequest.Builder.() -> Unit = {}): ChangeAppUserSettingsResponse

Changes user settings of the web app identified by its manifestId. If the app was not installed, this command returns an error. Unset parameters will be ignored; unrecognized values will cause an error.

getOsAppState

suspend fun getOsAppState(manifestId: String): GetOsAppStateResponse

suspend fun getOsAppState(input: GetOsAppStateRequest): GetOsAppStateResponse

Returns the following OS state for the given manifest id.

install

suspend fun install(input: InstallRequest): InstallResponse

@JvmOverloads

inline suspend fun install(manifestId: String, optionalArgs: InstallRequest.Builder.() -> Unit = {}): InstallResponse

Installs the given manifest identity, optionally using the given install_url or IWA bundle location.

launch

suspend fun launch(input: LaunchRequest): LaunchResponse

@JvmOverloads

inline suspend fun launch(manifestId: String, optionalArgs: LaunchRequest.Builder.() -> Unit = {}): LaunchResponse

Launches the installed web app, or an url in the same web app instead of the default start url if it is provided. Returns a page Target.TargetID which can be used to attach to via Target.attachToTarget or similar APIs.

launchFilesInApp

suspend fun launchFilesInApp(input: LaunchFilesInAppRequest): LaunchFilesInAppResponse

suspend fun launchFilesInApp(manifestId: String, files: List<String>): LaunchFilesInAppResponse

Opens one or more local files from an installed web app identified by its manifestId. The web app needs to have file handlers registered to process the files. The API returns one or more page Target.TargetIDs which can be used to attach to via Target.attachToTarget or similar APIs. If some files in the parameters cannot be handled by the web app, they will be ignored. If none of the files can be handled, this API returns an error. If no files are provided as the parameter, this API also returns an error.

openCurrentPageInApp

suspend fun openCurrentPageInApp(manifestId: String): OpenCurrentPageInAppResponse

suspend fun openCurrentPageInApp(input: OpenCurrentPageInAppRequest): OpenCurrentPageInAppResponse

Opens the current page in its web app identified by the manifest id, needs to be called on a page target. This function returns immediately without waiting for the app to finish loading.

uninstall

suspend fun uninstall(manifestId: String): UninstallResponse

suspend fun uninstall(input: UninstallRequest): UninstallResponse

Uninstalls the given manifest_id and closes any opened app windows.