pwa

package
v0.158.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 17, 2026 License: MIT Imports: 2 Imported by: 0

Documentation

Overview

Package pwa provides the Chrome DevTools Protocol commands, types, and events for the PWA domain.

This domain allows interacting with the browser to control PWAs.

Generated by the pdlgen command.

Index

Constants

View Source 
const (
	CommandGetOsAppState         = "PWA.getOsAppState"
	CommandInstall               = "PWA.install"
	CommandUninstall             = "PWA.uninstall"
	CommandLaunch                = "PWA.launch"
	CommandLaunchFilesInApp      = "PWA.launchFilesInApp"
	CommandOpenCurrentPageInApp  = "PWA.openCurrentPageInApp"
	CommandChangeAppUserSettings = "PWA.changeAppUserSettings"
)

Command names.

Variables

View Source 
var ChangeAppUserSettings = cdp.Command[ChangeAppUserSettingsParams, cdp.Empty]{Method: CommandChangeAppUserSettings}

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-changeAppUserSettings

View Source 
var GetOsAppState = cdp.Command[GetOsAppStateParams, GetOsAppStateResult]{Method: CommandGetOsAppState}

GetOsAppState returns the following OS state for the given manifest id.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-getOsAppState

View Source 
var Install = cdp.Command[InstallParams, cdp.Empty]{Method: CommandInstall}

Install 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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-install

View Source 
var Launch = cdp.Command[LaunchParams, LaunchResult]{Method: CommandLaunch}

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-launch

View Source 
var LaunchFilesInApp = cdp.Command[LaunchFilesInAppParams, LaunchFilesInAppResult]{Method: CommandLaunchFilesInApp}

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-launchFilesInApp

View Source 
var OpenCurrentPageInApp = cdp.Command[OpenCurrentPageInAppParams, cdp.Empty]{Method: CommandOpenCurrentPageInApp}

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-openCurrentPageInApp

View Source 
var Uninstall = cdp.Command[UninstallParams, cdp.Empty]{Method: CommandUninstall}

Uninstall uninstalls the given manifest_id and closes any opened app windows.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#method-uninstall

Functions

This section is empty.

Types

type ChangeAppUserSettingsParams 

type ChangeAppUserSettingsParams struct {
	ManifestID    string      `json:"manifestId"`
	LinkCapturing *bool       `json:"linkCapturing,omitempty,omitzero"` // 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 `json:"displayMode,omitempty,omitzero"`
}

ChangeAppUserSettingsParams are the parameters of the command PWA.changeAppUserSettings.

type DisplayMode 

type DisplayMode string

DisplayMode if user prefers opening the app in browser or an app window.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#type-DisplayMode 

const (
	DisplayModeStandalone DisplayMode = "standalone"
	DisplayModeBrowser    DisplayMode = "browser"
)

DisplayMode values.

func (DisplayMode) String 

func (t DisplayMode) String() string

String returns the DisplayMode as string value.

type FileHandler 

type FileHandler struct {
	Action      string               `json:"action"`
	Accepts     []*FileHandlerAccept `json:"accepts"`
	DisplayName string               `json:"displayName"`
}

FileHandler [no description].

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#type-FileHandler

type FileHandlerAccept 

type FileHandlerAccept struct {
	MediaType      string   `json:"mediaType"` // New name of the mimetype according to https://www.iana.org/assignments/media-types/media-types.xhtml
	FileExtensions []string `json:"fileExtensions"`
}

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.

See: https://chromedevtools.github.io/devtools-protocol/tot/PWA#type-FileHandlerAccept

type GetOsAppStateParams 

type GetOsAppStateParams struct {
	ManifestID string `json:"manifestId"` // 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.
}

GetOsAppStateParams are the parameters of the command PWA.getOsAppState.

type GetOsAppStateResult added in v0.157.3 

type GetOsAppStateResult struct {
	BadgeCount   int64          `json:"badgeCount,omitempty,omitzero"`
	FileHandlers []*FileHandler `json:"fileHandlers,omitempty,omitzero"`
}

GetOsAppStateResult is the result of the command PWA.getOsAppState.

type InstallParams 

type InstallParams struct {
	ManifestID            string `json:"manifestId"`
	InstallURLOrBundleURL string `json:"installUrlOrBundleUrl,omitempty,omitzero"` // The location of the app or bundle overriding the one derived from the manifestId.
}

InstallParams are the parameters of the command PWA.install.

type LaunchFilesInAppParams 

type LaunchFilesInAppParams struct {
	ManifestID string   `json:"manifestId"`
	Files      []string `json:"files"`
}

LaunchFilesInAppParams are the parameters of the command PWA.launchFilesInApp.

type LaunchFilesInAppResult added in v0.157.3 

type LaunchFilesInAppResult struct {
	TargetIDs []target.ID `json:"targetIds,omitempty,omitzero"` // IDs of the tab targets created as the result.
}

LaunchFilesInAppResult is the result of the command PWA.launchFilesInApp.

type LaunchParams 

type LaunchParams struct {
	ManifestID string `json:"manifestId"`
	URL        string `json:"url,omitempty,omitzero"`
}

LaunchParams are the parameters of the command PWA.launch.

type LaunchResult added in v0.157.3 

type LaunchResult struct {
	TargetID target.ID `json:"targetId,omitempty,omitzero"` // ID of the tab target created as a result.
}

LaunchResult is the result of the command PWA.launch.

type OpenCurrentPageInAppParams 

type OpenCurrentPageInAppParams struct {
	ManifestID string `json:"manifestId"`
}

OpenCurrentPageInAppParams are the parameters of the command PWA.openCurrentPageInApp.

type UninstallParams 

type UninstallParams struct {
	ManifestID string `json:"manifestId"`
}

UninstallParams are the parameters of the command PWA.uninstall.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.