Namespace OpenQA.Selenium.DevTools.V148.PWA
Classes
- ChangeAppUserSettingsCommandResponse
Response for 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.
- ChangeAppUserSettingsCommandSettings
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.
- FileHandler
FileHandler
- 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
- GetOsAppStateCommandResponse
Response for Returns the following OS state for the given manifest id.
- GetOsAppStateCommandSettings
Returns the following OS state for the given manifest id.
- InstallCommandResponse
Response for Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
IWA-specific install description: manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
File installation mode: The installUrlOrBundleUrl can be either file:// or http(s):// pointing to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to The .swbn file's signing key.
Dev proxy installation mode: installUrlOrBundleUrl must be http(s):// that serves dev mode IWA. web_package::SignedWebBundleId must be of type dev proxy.
The advantage of dev proxy mode is that all changes to IWA automatically will be reflected in the running app without reinstallation.
To generate bundle id for proxy mode:
- Generate 32 random bytes.
- Add a specific suffix at the end following the documentation https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix
- Encode the entire sequence using Base32 without padding.
If Chrome is not in IWA dev mode, the installation will fail, regardless of the state of the allowlist.
- InstallCommandSettings
Installs the given manifest identity, optionally using the given installUrlOrBundleUrl
IWA-specific install description: manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId
File installation mode: The installUrlOrBundleUrl can be either file:// or http(s):// pointing to a signed web bundle (.swbn). In this case SignedWebBundleId must correspond to The .swbn file's signing key.
Dev proxy installation mode: installUrlOrBundleUrl must be http(s):// that serves dev mode IWA. web_package::SignedWebBundleId must be of type dev proxy.
The advantage of dev proxy mode is that all changes to IWA automatically will be reflected in the running app without reinstallation.
To generate bundle id for proxy mode:
- Generate 32 random bytes.
- Add a specific suffix at the end following the documentation https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix
- Encode the entire sequence using Base32 without padding.
If Chrome is not in IWA dev mode, the installation will fail, regardless of the state of the allowlist.
- LaunchCommandResponse
Response for 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.
- LaunchCommandSettings
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.
- LaunchFilesInAppCommandResponse
Response for 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.
- LaunchFilesInAppCommandSettings
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.
- OpenCurrentPageInAppCommandResponse
Response for 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.
- OpenCurrentPageInAppCommandSettings
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.
- PWAAdapter
Represents an adapter for the PWA domain to simplify the command interface.
- UninstallCommandResponse
Response for Uninstalls the given manifest_id and closes any opened app windows.
- UninstallCommandSettings
Uninstalls the given manifest_id and closes any opened app windows.
Enums
- DisplayMode
If user prefers opening the app in browser or an app window.