| <!DOCTYPE html> |
| <html> |
| <head> |
| <meta charset="utf-8"> |
| <title>Namespace OpenQA.Selenium.DevTools.V143.PWA </title> |
| <meta name="viewport" content="width=device-width, initial-scale=1.0"> |
| <meta name="title" content="Namespace OpenQA.Selenium.DevTools.V143.PWA "> |
| |
| |
| <link rel="icon" href="../images/favicon.ico"> |
| <link rel="stylesheet" href="../public/docfx.min.css"> |
| <link rel="stylesheet" href="../public/main.css"> |
| <meta name="docfx:navrel" content="../toc.html"> |
| <meta name="docfx:tocrel" content="toc.html"> |
| |
| <meta name="docfx:rel" content="../"> |
| |
| |
| |
| <meta name="loc:inThisArticle" content="In this article"> |
| <meta name="loc:searchResultsCount" content="{count} results for "{query}""> |
| <meta name="loc:searchNoResults" content="No results for "{query}""> |
| <meta name="loc:tocFilter" content="Filter by title"> |
| <meta name="loc:nextArticle" content="Next"> |
| <meta name="loc:prevArticle" content="Previous"> |
| <meta name="loc:themeLight" content="Light"> |
| <meta name="loc:themeDark" content="Dark"> |
| <meta name="loc:themeAuto" content="Auto"> |
| <meta name="loc:changeTheme" content="Change theme"> |
| <meta name="loc:copy" content="Copy"> |
| <meta name="loc:downloadPdf" content="Download PDF"> |
| |
| <script type="module" src="./../public/docfx.min.js"></script> |
| |
| <script> |
| const theme = localStorage.getItem('theme') || 'auto' |
| document.documentElement.setAttribute('data-bs-theme', theme === 'auto' ? (window.matchMedia('(prefers-color-scheme: dark)').matches ? 'dark' : 'light') : theme) |
| </script> |
| |
| </head> |
| |
| <body class="tex2jax_ignore" data-layout="" data-yaml-mime="ManagedReference"> |
| <header class="bg-body border-bottom"> |
| <nav id="autocollapse" class="navbar navbar-expand-md" role="navigation"> |
| <div class="container-xxl flex-nowrap"> |
| <a class="navbar-brand" href="../index.html"> |
| <img id="logo" class="svg" src="../images/logo.svg" alt="Selenium .NET API"> |
| Selenium .NET API |
| </a> |
| <button class="btn btn-lg d-md-none border-0" type="button" data-bs-toggle="collapse" data-bs-target="#navpanel" aria-controls="navpanel" aria-expanded="false" aria-label="Toggle navigation"> |
| <i class="bi bi-three-dots"></i> |
| </button> |
| <div class="collapse navbar-collapse" id="navpanel"> |
| <div id="navbar"> |
| <form class="search" role="search" id="search"> |
| <i class="bi bi-search"></i> |
| <input class="form-control" id="search-query" type="search" disabled placeholder="Search" autocomplete="off" aria-label="Search"> |
| </form> |
| </div> |
| </div> |
| </div> |
| </nav> |
| </header> |
| |
| <main class="container-xxl"> |
| <div class="toc-offcanvas"> |
| <div class="offcanvas-md offcanvas-start" tabindex="-1" id="tocOffcanvas" aria-labelledby="tocOffcanvasLabel"> |
| <div class="offcanvas-header"> |
| <h5 class="offcanvas-title" id="tocOffcanvasLabel">Table of Contents</h5> |
| <button type="button" class="btn-close" data-bs-dismiss="offcanvas" data-bs-target="#tocOffcanvas" aria-label="Close"></button> |
| </div> |
| <div class="offcanvas-body"> |
| <nav class="toc" id="toc"></nav> |
| </div> |
| </div> |
| </div> |
| |
| <div class="content"> |
| <div class="actionbar"> |
| <button class="btn btn-lg border-0 d-md-none" type="button" data-bs-toggle="offcanvas" data-bs-target="#tocOffcanvas" aria-controls="tocOffcanvas" aria-expanded="false" aria-label="Show table of contents"> |
| <i class="bi bi-list"></i> |
| </button> |
| |
| <nav id="breadcrumb"></nav> |
| </div> |
| |
| <article data-uid="OpenQA.Selenium.DevTools.V143.PWA"> |
| |
| <h1 id="OpenQA_Selenium_DevTools_V143_PWA" data-uid="OpenQA.Selenium.DevTools.V143.PWA" class="text-break">Namespace OpenQA.Selenium.DevTools.V143.PWA</h1> |
| <div class="markdown level0 summary"></div> |
| <div class="markdown level0 conceptual"></div> |
| <div class="markdown level0 remarks"></div> |
| |
| <h3 id="classes"> |
| Classes |
| </h3> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.ChangeAppUserSettingsCommandResponse.html">ChangeAppUserSettingsCommandResponse</a></dt> |
| <dd><p>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.</p> |
| <p>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.</p> |
| <p>See the comment of each parameter.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.ChangeAppUserSettingsCommandSettings.html">ChangeAppUserSettingsCommandSettings</a></dt> |
| <dd><p>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.</p> |
| <p>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.</p> |
| <p>See the comment of each parameter.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.FileHandler.html">FileHandler</a></dt> |
| <dd><p>FileHandler</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.FileHandlerAccept.html">FileHandlerAccept</a></dt> |
| <dd><p>The following types are the replica of |
| <a href="https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67">https://crsrc.org/c/chrome/browser/web_applications/proto/web_app_os_integration_state.proto;drc=9910d3be894c8f142c977ba1023f30a656bc13fc;l=67</a></p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.GetOsAppStateCommandResponse.html">GetOsAppStateCommandResponse</a></dt> |
| <dd><p>Response for Returns the following OS state for the given manifest id.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.GetOsAppStateCommandSettings.html">GetOsAppStateCommandSettings</a></dt> |
| <dd><p>Returns the following OS state for the given manifest id.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.InstallCommandResponse.html">InstallCommandResponse</a></dt> |
| <dd><p>Response for Installs the given manifest identity, optionally using the given installUrlOrBundleUrl</p> |
| <p>IWA-specific install description: |
| manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId</p> |
| <p>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.</p> |
| <p>Dev proxy installation mode: |
| installUrlOrBundleUrl must be http(s):// that serves dev mode IWA. |
| web_package::SignedWebBundleId must be of type dev proxy.</p> |
| <p>The advantage of dev proxy mode is that all changes to IWA |
| automatically will be reflected in the running app without |
| reinstallation.</p> |
| <p>To generate bundle id for proxy mode:</p> |
| <ol> |
| <li>Generate 32 random bytes.</li> |
| <li>Add a specific suffix at the end following the documentation |
| <a href="https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix">https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix</a></li> |
| <li>Encode the entire sequence using Base32 without padding.</li> |
| </ol> |
| <p>If Chrome is not in IWA dev |
| mode, the installation will fail, regardless of the state of the allowlist.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.InstallCommandSettings.html">InstallCommandSettings</a></dt> |
| <dd><p>Installs the given manifest identity, optionally using the given installUrlOrBundleUrl</p> |
| <p>IWA-specific install description: |
| manifestId corresponds to isolated-app:// + web_package::SignedWebBundleId</p> |
| <p>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.</p> |
| <p>Dev proxy installation mode: |
| installUrlOrBundleUrl must be http(s):// that serves dev mode IWA. |
| web_package::SignedWebBundleId must be of type dev proxy.</p> |
| <p>The advantage of dev proxy mode is that all changes to IWA |
| automatically will be reflected in the running app without |
| reinstallation.</p> |
| <p>To generate bundle id for proxy mode:</p> |
| <ol> |
| <li>Generate 32 random bytes.</li> |
| <li>Add a specific suffix at the end following the documentation |
| <a href="https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix">https://github.com/WICG/isolated-web-apps/blob/main/Scheme.md#suffix</a></li> |
| <li>Encode the entire sequence using Base32 without padding.</li> |
| </ol> |
| <p>If Chrome is not in IWA dev |
| mode, the installation will fail, regardless of the state of the allowlist.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.LaunchCommandResponse.html">LaunchCommandResponse</a></dt> |
| <dd><p>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.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.LaunchCommandSettings.html">LaunchCommandSettings</a></dt> |
| <dd><p>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.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.LaunchFilesInAppCommandResponse.html">LaunchFilesInAppCommandResponse</a></dt> |
| <dd><p>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.</p> |
| <p>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.</p> |
| <p>TODO(crbug.com/339454034): Check the existences of the input files.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.LaunchFilesInAppCommandSettings.html">LaunchFilesInAppCommandSettings</a></dt> |
| <dd><p>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.</p> |
| <p>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.</p> |
| <p>TODO(crbug.com/339454034): Check the existences of the input files.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.OpenCurrentPageInAppCommandResponse.html">OpenCurrentPageInAppCommandResponse</a></dt> |
| <dd><p>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.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.OpenCurrentPageInAppCommandSettings.html">OpenCurrentPageInAppCommandSettings</a></dt> |
| <dd><p>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.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.PWAAdapter.html">PWAAdapter</a></dt> |
| <dd><p>Represents an adapter for the PWA domain to simplify the command interface.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.UninstallCommandResponse.html">UninstallCommandResponse</a></dt> |
| <dd><p>Response for Uninstalls the given manifest_id and closes any opened app windows.</p> |
| </dd> |
| </dl> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.UninstallCommandSettings.html">UninstallCommandSettings</a></dt> |
| <dd><p>Uninstalls the given manifest_id and closes any opened app windows.</p> |
| </dd> |
| </dl> |
| <h3 id="enums"> |
| Enums |
| </h3> |
| <dl class="jumplist"> |
| <dt><a class="xref" href="OpenQA.Selenium.DevTools.V143.PWA.DisplayMode.html">DisplayMode</a></dt> |
| <dd><p>If user prefers opening the app in browser or an app window.</p> |
| </dd> |
| </dl> |
| |
| |
| </article> |
| |
| <div class="contribution d-print-none"> |
| </div> |
| |
| |
| </div> |
| |
| <div class="affix"> |
| <nav id="affix"></nav> |
| </div> |
| </main> |
| |
| <div class="container-xxl search-results" id="search-results"></div> |
| |
| <footer class="border-top text-secondary"> |
| <div class="container-xxl"> |
| <div class="flex-fill"> |
| <span>Made with <a href="https://dotnet.github.io/docfx">docfx</a></span> |
| </div> |
| </div> |
| </footer> |
| </body> |
| </html> |
