PWA Domain
This domain allows interacting with the browser to control PWAs.
Methods
- PWA.getOsAppState
- PWA.install
- PWA.launch
- PWA.launchFilesInApp
- PWA.openCurrentPageInApp
- PWA.uninstall
Types
Methods
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
Optional
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
Optional
string
Return object
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 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 finishing loading.
Parameters
manifestId
string
PWA.uninstall #
Uninstals the given manifest_id and closes any opened app windows.
Parameters
manifestId
string
Types
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
]