Chrome DevTools Protocol

Methods

PWA.changeAppUserSettings

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.

Unlike the ones defined in the manifest files of the web apps, these settings are provided by the browser and controlled by the users, they impact the way the browser handling the web apps.

See the comment of each parameter.

parameters
manifestId
string
linkCapturing
boolean

If user allows the links clicked on by the user in the app's scope, or extended scope if the manifest has scope extensions and the flags DesktopPWAsLinkCapturingWithScopeExtensions and WebAppEnableScopeExtensions are enabled.

Note, the API does not support resetting the linkCapturing to the initial value, uninstalling and installing the web app again will reset it.

TODO(crbug.com/339453269): Setting this value on ChromeOS is not supported yet.

displayMode
DisplayMode

PWA.getOsAppState

Returns the following OS state for the given manifest id.

parameters
manifestId
string

The id from the webapp's manifest file, commonly it's the url of the site installing the webapp. See https://web.dev/learn/pwa/web-app-manifest.

Return Object
badgeCount
integer
fileHandlers
array[ FileHandler ]

PWA.install

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

TODO(crbug.com/337872319) Support IWA to meet the following specific requirement. IWA-specific install description: If the manifest_id is isolated-app://, install_url_or_bundle_url is required, and can be either an http(s) URL or file:// URL pointing to a signed web bundle (.swbn). The .swbn file's signing key must correspond to manifest_id. If Chrome is not in IWA dev mode, the installation will fail, regardless of the state of the allowlist.

parameters
manifestId
string
installUrlOrBundleUrl
string

The location of the app or bundle overriding the one derived from the manifestId.

PWA.launch

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.

parameters
manifestId
string
url
string
Return Object
targetId
Target.TargetID

ID of the tab target created as a result.

PWA.launchFilesInApp

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.

According to the definition of the file handlers in the manifest file, one Target.TargetID may represent a page handling one or more files. The order of the returned Target.TargetIDs is not guaranteed.

TODO(crbug.com/339454034): Check the existences of the input files.

parameters
manifestId
string
files
array[ string ]
Return Object
targetIds
array[ Target.TargetID ]

IDs of the tab targets created as the result.

PWA.openCurrentPageInApp

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.

parameters
manifestId
string

PWA.uninstall

Uninstalls the given manifest_id and closes any opened app windows.

parameters
manifestId
string

Types

PWA.DisplayMode

If user prefers opening the app in browser or an app window.

Allowed Values: standalone, browser

Type: string

PWA.FileHandler

Type: object

properties
action
string
accepts
array[ FileHandlerAccept ]
displayName
string

PWA.FileHandlerAccept

The following types are the replica of https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67

Type: object

properties
mediaType
string

New name of the mimetype according to https://www.iana.org/assignments/media-types/media-types.xhtml

fileExtensions
array[ string ]