Table of Contents

Class PWAAdapter

Namespace
OpenQA.Selenium.DevTools.V146.PWA
Assembly
Selenium.WebDriver.dll

Represents an adapter for the PWA domain to simplify the command interface.

public class PWAAdapter
Inheritance
PWAAdapter
Inherited Members

Constructors

PWAAdapter(IDevToolsSession)

Initializes a new instance of the PWAAdapter class.

public PWAAdapter(IDevToolsSession session)

Parameters

session IDevToolsSession

The IDevToolsSession to be used with this adapter.

Exceptions

ArgumentNullException

If session is null.

Properties

Session

Gets the DevToolsSession associated with the adapter.

public IDevToolsSession Session { get; }

Property Value

IDevToolsSession

Methods

ChangeAppUserSettings(ChangeAppUserSettingsCommandSettings, CancellationToken, int?, bool)

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.

public Task<ChangeAppUserSettingsCommandResponse?> ChangeAppUserSettings(ChangeAppUserSettingsCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command ChangeAppUserSettingsCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<ChangeAppUserSettingsCommandResponse>

GetOsAppState(GetOsAppStateCommandSettings, CancellationToken, int?, bool)

Returns the following OS state for the given manifest id.

public Task<GetOsAppStateCommandResponse> GetOsAppState(GetOsAppStateCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command GetOsAppStateCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<GetOsAppStateCommandResponse>

Install(InstallCommandSettings, CancellationToken, int?, bool)

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:

  1. Generate 32 random bytes.
  2. Add a specific suffix at the end following the documentation https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix
  3. 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.

public Task<InstallCommandResponse?> Install(InstallCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command InstallCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<InstallCommandResponse>

Launch(LaunchCommandSettings, CancellationToken, int?, bool)

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.

public Task<LaunchCommandResponse> Launch(LaunchCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command LaunchCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<LaunchCommandResponse>

LaunchFilesInApp(LaunchFilesInAppCommandSettings, CancellationToken, int?, bool)

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.

public Task<LaunchFilesInAppCommandResponse> LaunchFilesInApp(LaunchFilesInAppCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command LaunchFilesInAppCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<LaunchFilesInAppCommandResponse>

OpenCurrentPageInApp(OpenCurrentPageInAppCommandSettings, CancellationToken, int?, bool)

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.

public Task<OpenCurrentPageInAppCommandResponse?> OpenCurrentPageInApp(OpenCurrentPageInAppCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command OpenCurrentPageInAppCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<OpenCurrentPageInAppCommandResponse>

Uninstall(UninstallCommandSettings, CancellationToken, int?, bool)

Uninstalls the given manifest_id and closes any opened app windows.

public Task<UninstallCommandResponse?> Uninstall(UninstallCommandSettings command, CancellationToken cancellationToken = default, int? millisecondsTimeout = null, bool throwExceptionIfResponseNotReceived = true)

Parameters

command UninstallCommandSettings
cancellationToken CancellationToken
millisecondsTimeout int?
throwExceptionIfResponseNotReceived bool

Returns

Task<UninstallCommandResponse>
Edit this page