// Copyright 2020 The Chromium Authors // Use of this source code is governed by a BSD-style license that can be // found in the LICENSE file. /** * This file is auto-generated, do not edit manually. * * Re-generate with: npm run generate-protocol-resources. */ import type * as Protocol from './protocol.js' /** * API generated from Protocol commands and events. */ declare namespace ProtocolProxyApi { export type ProtocolDomainName = keyof ProtocolApi; export interface ProtocolApi { Accessibility: AccessibilityApi; Animation: AnimationApi; Audits: AuditsApi; Autofill: AutofillApi; BackgroundService: BackgroundServiceApi; BluetoothEmulation: BluetoothEmulationApi; Browser: BrowserApi; CSS: CSSApi; CacheStorage: CacheStorageApi; Cast: CastApi; CrashReportContext: CrashReportContextApi; DOM: DOMApi; DOMDebugger: DOMDebuggerApi; DOMSnapshot: DOMSnapshotApi; DOMStorage: DOMStorageApi; DeviceAccess: DeviceAccessApi; DeviceOrientation: DeviceOrientationApi; Emulation: EmulationApi; EventBreakpoints: EventBreakpointsApi; Extensions: ExtensionsApi; FedCm: FedCmApi; Fetch: FetchApi; FileSystem: FileSystemApi; HeadlessExperimental: HeadlessExperimentalApi; IO: IOApi; IndexedDB: IndexedDBApi; Input: InputApi; Inspector: InspectorApi; LayerTree: LayerTreeApi; Log: LogApi; Media: MediaApi; Memory: MemoryApi; Network: NetworkApi; Overlay: OverlayApi; PWA: PWAApi; Page: PageApi; Performance: PerformanceApi; PerformanceTimeline: PerformanceTimelineApi; Preload: PreloadApi; Security: SecurityApi; ServiceWorker: ServiceWorkerApi; SmartCardEmulation: SmartCardEmulationApi; Storage: StorageApi; SystemInfo: SystemInfoApi; Target: TargetApi; Tethering: TetheringApi; Tracing: TracingApi; WebAudio: WebAudioApi; WebAuthn: WebAuthnApi; WebMCP: WebMCPApi; Debugger: DebuggerApi; HeapProfiler: HeapProfilerApi; Profiler: ProfilerApi; Runtime: RuntimeApi; Schema: SchemaApi; } export interface ProtocolDispatchers { Accessibility: AccessibilityDispatcher; Animation: AnimationDispatcher; Audits: AuditsDispatcher; Autofill: AutofillDispatcher; BackgroundService: BackgroundServiceDispatcher; BluetoothEmulation: BluetoothEmulationDispatcher; Browser: BrowserDispatcher; CSS: CSSDispatcher; CacheStorage: CacheStorageDispatcher; Cast: CastDispatcher; CrashReportContext: CrashReportContextDispatcher; DOM: DOMDispatcher; DOMDebugger: DOMDebuggerDispatcher; DOMSnapshot: DOMSnapshotDispatcher; DOMStorage: DOMStorageDispatcher; DeviceAccess: DeviceAccessDispatcher; DeviceOrientation: DeviceOrientationDispatcher; Emulation: EmulationDispatcher; EventBreakpoints: EventBreakpointsDispatcher; Extensions: ExtensionsDispatcher; FedCm: FedCmDispatcher; Fetch: FetchDispatcher; FileSystem: FileSystemDispatcher; HeadlessExperimental: HeadlessExperimentalDispatcher; IO: IODispatcher; IndexedDB: IndexedDBDispatcher; Input: InputDispatcher; Inspector: InspectorDispatcher; LayerTree: LayerTreeDispatcher; Log: LogDispatcher; Media: MediaDispatcher; Memory: MemoryDispatcher; Network: NetworkDispatcher; Overlay: OverlayDispatcher; PWA: PWADispatcher; Page: PageDispatcher; Performance: PerformanceDispatcher; PerformanceTimeline: PerformanceTimelineDispatcher; Preload: PreloadDispatcher; Security: SecurityDispatcher; ServiceWorker: ServiceWorkerDispatcher; SmartCardEmulation: SmartCardEmulationDispatcher; Storage: StorageDispatcher; SystemInfo: SystemInfoDispatcher; Target: TargetDispatcher; Tethering: TetheringDispatcher; Tracing: TracingDispatcher; WebAudio: WebAudioDispatcher; WebAuthn: WebAuthnDispatcher; WebMCP: WebMCPDispatcher; Debugger: DebuggerDispatcher; HeapProfiler: HeapProfilerDispatcher; Profiler: ProfilerDispatcher; Runtime: RuntimeDispatcher; Schema: SchemaDispatcher; } export interface AccessibilityApi { /** * Disables the accessibility domain. */ invoke_disable(): Promise; /** * Enables the accessibility domain which causes `AXNodeId`s to remain consistent between method calls. * This turns on accessibility for the page, which can impact performance until accessibility is disabled. */ invoke_enable(): Promise; /** * Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists. */ invoke_getPartialAXTree(params: Protocol.Accessibility.GetPartialAXTreeRequest): Promise; /** * Fetches the entire accessibility tree for the root Document */ invoke_getFullAXTree(params: Protocol.Accessibility.GetFullAXTreeRequest): Promise; /** * Fetches the root node. * Requires `enable()` to have been called previously. */ invoke_getRootAXNode(params: Protocol.Accessibility.GetRootAXNodeRequest): Promise; /** * Fetches a node and all ancestors up to and including the root. * Requires `enable()` to have been called previously. */ invoke_getAXNodeAndAncestors(params: Protocol.Accessibility.GetAXNodeAndAncestorsRequest): Promise; /** * Fetches a particular accessibility node by AXNodeId. * Requires `enable()` to have been called previously. */ invoke_getChildAXNodes(params: Protocol.Accessibility.GetChildAXNodesRequest): Promise; /** * Query a DOM node's accessibility subtree for accessible name and role. * This command computes the name and role for all nodes in the subtree, including those that are * ignored for accessibility, and returns those that match the specified name and role. If no DOM * node is specified, or the DOM node does not exist, the command returns an error. If neither * `accessibleName` or `role` is specified, it returns all the accessibility nodes in the subtree. */ invoke_queryAXTree(params: Protocol.Accessibility.QueryAXTreeRequest): Promise; } export interface AccessibilityDispatcher { /** * The loadComplete event mirrors the load complete event sent by the browser to assistive * technology when the web page has finished loading. */ loadComplete(params: Protocol.Accessibility.LoadCompleteEvent): void; /** * The nodesUpdated event is sent every time a previously requested node has changed the in tree. */ nodesUpdated(params: Protocol.Accessibility.NodesUpdatedEvent): void; } export interface AnimationApi { /** * Disables animation domain notifications. */ invoke_disable(): Promise; /** * Enables animation domain notifications. */ invoke_enable(): Promise; /** * Returns the current time of the an animation. */ invoke_getCurrentTime(params: Protocol.Animation.GetCurrentTimeRequest): Promise; /** * Gets the playback rate of the document timeline. */ invoke_getPlaybackRate(): Promise; /** * Releases a set of animations to no longer be manipulated. */ invoke_releaseAnimations(params: Protocol.Animation.ReleaseAnimationsRequest): Promise; /** * Gets the remote object of the Animation. */ invoke_resolveAnimation(params: Protocol.Animation.ResolveAnimationRequest): Promise; /** * Seek a set of animations to a particular time within each animation. */ invoke_seekAnimations(params: Protocol.Animation.SeekAnimationsRequest): Promise; /** * Sets the paused state of a set of animations. */ invoke_setPaused(params: Protocol.Animation.SetPausedRequest): Promise; /** * Sets the playback rate of the document timeline. */ invoke_setPlaybackRate(params: Protocol.Animation.SetPlaybackRateRequest): Promise; /** * Sets the timing of an animation node. */ invoke_setTiming(params: Protocol.Animation.SetTimingRequest): Promise; } export interface AnimationDispatcher { /** * Event for when an animation has been cancelled. */ animationCanceled(params: Protocol.Animation.AnimationCanceledEvent): void; /** * Event for each animation that has been created. */ animationCreated(params: Protocol.Animation.AnimationCreatedEvent): void; /** * Event for animation that has been started. */ animationStarted(params: Protocol.Animation.AnimationStartedEvent): void; /** * Event for animation that has been updated. */ animationUpdated(params: Protocol.Animation.AnimationUpdatedEvent): void; } export interface AuditsApi { /** * Returns the response body and size if it were re-encoded with the specified settings. Only * applies to images. */ invoke_getEncodedResponse(params: Protocol.Audits.GetEncodedResponseRequest): Promise; /** * Disables issues domain, prevents further issues from being reported to the client. */ invoke_disable(): Promise; /** * Enables issues domain, sends the issues collected so far to the client by means of the * `issueAdded` event. */ invoke_enable(): Promise; /** * Runs the form issues check for the target page. Found issues are reported * using Audits.issueAdded event. */ invoke_checkFormsIssues(): Promise; } export interface AuditsDispatcher { issueAdded(params: Protocol.Audits.IssueAddedEvent): void; } export interface AutofillApi { /** * Trigger autofill on a form identified by the fieldId. * If the field and related form cannot be autofilled, returns an error. */ invoke_trigger(params: Protocol.Autofill.TriggerRequest): Promise; /** * Set addresses so that developers can verify their forms implementation. */ invoke_setAddresses(params: Protocol.Autofill.SetAddressesRequest): Promise; /** * Disables autofill domain notifications. */ invoke_disable(): Promise; /** * Enables autofill domain notifications. */ invoke_enable(): Promise; } export interface AutofillDispatcher { /** * Emitted when an address form is filled. */ addressFormFilled(params: Protocol.Autofill.AddressFormFilledEvent): void; } export interface BackgroundServiceApi { /** * Enables event updates for the service. */ invoke_startObserving(params: Protocol.BackgroundService.StartObservingRequest): Promise; /** * Disables event updates for the service. */ invoke_stopObserving(params: Protocol.BackgroundService.StopObservingRequest): Promise; /** * Set the recording state for the service. */ invoke_setRecording(params: Protocol.BackgroundService.SetRecordingRequest): Promise; /** * Clears all stored data for the service. */ invoke_clearEvents(params: Protocol.BackgroundService.ClearEventsRequest): Promise; } export interface BackgroundServiceDispatcher { /** * Called when the recording state for the service has been updated. */ recordingStateChanged(params: Protocol.BackgroundService.RecordingStateChangedEvent): void; /** * Called with all existing backgroundServiceEvents when enabled, and all new * events afterwards if enabled and recording. */ backgroundServiceEventReceived(params: Protocol.BackgroundService.BackgroundServiceEventReceivedEvent): void; } export interface BluetoothEmulationApi { /** * Enable the BluetoothEmulation domain. */ invoke_enable(params: Protocol.BluetoothEmulation.EnableRequest): Promise; /** * Set the state of the simulated central. */ invoke_setSimulatedCentralState(params: Protocol.BluetoothEmulation.SetSimulatedCentralStateRequest): Promise; /** * Disable the BluetoothEmulation domain. */ invoke_disable(): Promise; /** * Simulates a peripheral with |address|, |name| and |knownServiceUuids| * that has already been connected to the system. */ invoke_simulatePreconnectedPeripheral(params: Protocol.BluetoothEmulation.SimulatePreconnectedPeripheralRequest): Promise; /** * Simulates an advertisement packet described in |entry| being received by * the central. */ invoke_simulateAdvertisement(params: Protocol.BluetoothEmulation.SimulateAdvertisementRequest): Promise; /** * Simulates the response code from the peripheral with |address| for a * GATT operation of |type|. The |code| value follows the HCI Error Codes from * Bluetooth Core Specification Vol 2 Part D 1.3 List Of Error Codes. */ invoke_simulateGATTOperationResponse(params: Protocol.BluetoothEmulation.SimulateGATTOperationResponseRequest): Promise; /** * Simulates the response from the characteristic with |characteristicId| for a * characteristic operation of |type|. The |code| value follows the Error * Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response. * The |data| is expected to exist when simulating a successful read operation * response. */ invoke_simulateCharacteristicOperationResponse(params: Protocol.BluetoothEmulation.SimulateCharacteristicOperationResponseRequest): Promise; /** * Simulates the response from the descriptor with |descriptorId| for a * descriptor operation of |type|. The |code| value follows the Error * Codes from Bluetooth Core Specification Vol 3 Part F 3.4.1.1 Error Response. * The |data| is expected to exist when simulating a successful read operation * response. */ invoke_simulateDescriptorOperationResponse(params: Protocol.BluetoothEmulation.SimulateDescriptorOperationResponseRequest): Promise; /** * Adds a service with |serviceUuid| to the peripheral with |address|. */ invoke_addService(params: Protocol.BluetoothEmulation.AddServiceRequest): Promise; /** * Removes the service respresented by |serviceId| from the simulated central. */ invoke_removeService(params: Protocol.BluetoothEmulation.RemoveServiceRequest): Promise; /** * Adds a characteristic with |characteristicUuid| and |properties| to the * service represented by |serviceId|. */ invoke_addCharacteristic(params: Protocol.BluetoothEmulation.AddCharacteristicRequest): Promise; /** * Removes the characteristic respresented by |characteristicId| from the * simulated central. */ invoke_removeCharacteristic(params: Protocol.BluetoothEmulation.RemoveCharacteristicRequest): Promise; /** * Adds a descriptor with |descriptorUuid| to the characteristic respresented * by |characteristicId|. */ invoke_addDescriptor(params: Protocol.BluetoothEmulation.AddDescriptorRequest): Promise; /** * Removes the descriptor with |descriptorId| from the simulated central. */ invoke_removeDescriptor(params: Protocol.BluetoothEmulation.RemoveDescriptorRequest): Promise; /** * Simulates a GATT disconnection from the peripheral with |address|. */ invoke_simulateGATTDisconnection(params: Protocol.BluetoothEmulation.SimulateGATTDisconnectionRequest): Promise; } export interface BluetoothEmulationDispatcher { /** * Event for when a GATT operation of |type| to the peripheral with |address| * happened. */ gattOperationReceived(params: Protocol.BluetoothEmulation.GattOperationReceivedEvent): void; /** * Event for when a characteristic operation of |type| to the characteristic * respresented by |characteristicId| happened. |data| and |writeType| is * expected to exist when |type| is write. */ characteristicOperationReceived(params: Protocol.BluetoothEmulation.CharacteristicOperationReceivedEvent): void; /** * Event for when a descriptor operation of |type| to the descriptor * respresented by |descriptorId| happened. |data| is expected to exist when * |type| is write. */ descriptorOperationReceived(params: Protocol.BluetoothEmulation.DescriptorOperationReceivedEvent): void; } export interface BrowserApi { /** * Set permission settings for given embedding and embedded origins. */ invoke_setPermission(params: Protocol.Browser.SetPermissionRequest): Promise; /** * Grant specific permissions to the given origin and reject all others. Deprecated. Use * setPermission instead. * @deprecated */ invoke_grantPermissions(params: Protocol.Browser.GrantPermissionsRequest): Promise; /** * Reset all permission management for all origins. */ invoke_resetPermissions(params: Protocol.Browser.ResetPermissionsRequest): Promise; /** * Set the behavior when downloading a file. */ invoke_setDownloadBehavior(params: Protocol.Browser.SetDownloadBehaviorRequest): Promise; /** * Cancel a download if in progress */ invoke_cancelDownload(params: Protocol.Browser.CancelDownloadRequest): Promise; /** * Close browser gracefully. */ invoke_close(): Promise; /** * Crashes browser on the main thread. */ invoke_crash(): Promise; /** * Crashes GPU process. */ invoke_crashGpuProcess(): Promise; /** * Returns version information. */ invoke_getVersion(): Promise; /** * Returns the command line switches for the browser process if, and only if * --enable-automation is on the commandline. */ invoke_getBrowserCommandLine(): Promise; /** * Get Chrome histograms. */ invoke_getHistograms(params: Protocol.Browser.GetHistogramsRequest): Promise; /** * Get a Chrome histogram by name. */ invoke_getHistogram(params: Protocol.Browser.GetHistogramRequest): Promise; /** * Get position and size of the browser window. */ invoke_getWindowBounds(params: Protocol.Browser.GetWindowBoundsRequest): Promise; /** * Get the browser window that contains the devtools target. */ invoke_getWindowForTarget(params: Protocol.Browser.GetWindowForTargetRequest): Promise; /** * Set position and/or size of the browser window. */ invoke_setWindowBounds(params: Protocol.Browser.SetWindowBoundsRequest): Promise; /** * Set size of the browser contents resizing browser window as necessary. */ invoke_setContentsSize(params: Protocol.Browser.SetContentsSizeRequest): Promise; /** * Set dock tile details, platform-specific. */ invoke_setDockTile(params: Protocol.Browser.SetDockTileRequest): Promise; /** * Invoke custom browser commands used by telemetry. */ invoke_executeBrowserCommand(params: Protocol.Browser.ExecuteBrowserCommandRequest): Promise; /** * Allows a site to use privacy sandbox features that require enrollment * without the site actually being enrolled. Only supported on page targets. */ invoke_addPrivacySandboxEnrollmentOverride(params: Protocol.Browser.AddPrivacySandboxEnrollmentOverrideRequest): Promise; /** * Configures encryption keys used with a given privacy sandbox API to talk * to a trusted coordinator. Since this is intended for test automation only, * coordinatorOrigin must be a .test domain. No existing coordinator * configuration for the origin may exist. */ invoke_addPrivacySandboxCoordinatorKeyConfig(params: Protocol.Browser.AddPrivacySandboxCoordinatorKeyConfigRequest): Promise; } export interface BrowserDispatcher { /** * Fired when page is about to start a download. */ downloadWillBegin(params: Protocol.Browser.DownloadWillBeginEvent): void; /** * Fired when download makes progress. Last call has |done| == true. */ downloadProgress(params: Protocol.Browser.DownloadProgressEvent): void; } export interface CSSApi { /** * Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the * position specified by `location`. */ invoke_addRule(params: Protocol.CSS.AddRuleRequest): Promise; /** * Returns all class names from specified stylesheet. */ invoke_collectClassNames(params: Protocol.CSS.CollectClassNamesRequest): Promise; /** * Creates a new special "via-inspector" stylesheet in the frame with given `frameId`. */ invoke_createStyleSheet(params: Protocol.CSS.CreateStyleSheetRequest): Promise; /** * Disables the CSS agent for the given page. */ invoke_disable(): Promise; /** * Enables the CSS agent for the given page. Clients should not assume that the CSS agent has been * enabled until the result of this command is received. */ invoke_enable(): Promise; /** * Ensures that the given node will have specified pseudo-classes whenever its style is computed by * the browser. */ invoke_forcePseudoState(params: Protocol.CSS.ForcePseudoStateRequest): Promise; /** * Ensures that the given node is in its starting-style state. */ invoke_forceStartingStyle(params: Protocol.CSS.ForceStartingStyleRequest): Promise; invoke_getBackgroundColors(params: Protocol.CSS.GetBackgroundColorsRequest): Promise; /** * Returns the computed style for a DOM node identified by `nodeId`. */ invoke_getComputedStyleForNode(params: Protocol.CSS.GetComputedStyleForNodeRequest): Promise; /** * Resolve the specified values in the context of the provided element. * For example, a value of '1em' is evaluated according to the computed * 'font-size' of the element and a value 'calc(1px + 2px)' will be * resolved to '3px'. * If the `propertyName` was specified the `values` are resolved as if * they were property's declaration. If a value cannot be parsed according * to the provided property syntax, the value is parsed using combined * syntax as if null `propertyName` was provided. If the value cannot be * resolved even then, return the provided value without any changes. * Note: this function currently does not resolve CSS random() function, * it returns unmodified random() function parts.` */ invoke_resolveValues(params: Protocol.CSS.ResolveValuesRequest): Promise; invoke_getLonghandProperties(params: Protocol.CSS.GetLonghandPropertiesRequest): Promise; /** * Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM * attributes) for a DOM node identified by `nodeId`. */ invoke_getInlineStylesForNode(params: Protocol.CSS.GetInlineStylesForNodeRequest): Promise; /** * Returns the styles coming from animations & transitions * including the animation & transition styles coming from inheritance chain. */ invoke_getAnimatedStylesForNode(params: Protocol.CSS.GetAnimatedStylesForNodeRequest): Promise; /** * Returns requested styles for a DOM node identified by `nodeId`. */ invoke_getMatchedStylesForNode(params: Protocol.CSS.GetMatchedStylesForNodeRequest): Promise; /** * Returns the values of the default UA-defined environment variables used in env() */ invoke_getEnvironmentVariables(): Promise; /** * Returns all media queries parsed by the rendering engine. */ invoke_getMediaQueries(): Promise; /** * Requests information about platform fonts which we used to render child TextNodes in the given * node. */ invoke_getPlatformFontsForNode(params: Protocol.CSS.GetPlatformFontsForNodeRequest): Promise; /** * Returns the current textual content for a stylesheet. */ invoke_getStyleSheetText(params: Protocol.CSS.GetStyleSheetTextRequest): Promise; /** * Returns all layers parsed by the rendering engine for the tree scope of a node. * Given a DOM element identified by nodeId, getLayersForNode returns the root * layer for the nearest ancestor document or shadow root. The layer root contains * the full layer tree for the tree scope and their ordering. */ invoke_getLayersForNode(params: Protocol.CSS.GetLayersForNodeRequest): Promise; /** * Given a CSS selector text and a style sheet ID, getLocationForSelector * returns an array of locations of the CSS selector in the style sheet. */ invoke_getLocationForSelector(params: Protocol.CSS.GetLocationForSelectorRequest): Promise; /** * Starts tracking the given node for the computed style updates * and whenever the computed style is updated for node, it queues * a `computedStyleUpdated` event with throttling. * There can only be 1 node tracked for computed style updates * so passing a new node id removes tracking from the previous node. * Pass `undefined` to disable tracking. */ invoke_trackComputedStyleUpdatesForNode(params: Protocol.CSS.TrackComputedStyleUpdatesForNodeRequest): Promise; /** * Starts tracking the given computed styles for updates. The specified array of properties * replaces the one previously specified. Pass empty array to disable tracking. * Use takeComputedStyleUpdates to retrieve the list of nodes that had properties modified. * The changes to computed style properties are only tracked for nodes pushed to the front-end * by the DOM agent. If no changes to the tracked properties occur after the node has been pushed * to the front-end, no updates will be issued for the node. */ invoke_trackComputedStyleUpdates(params: Protocol.CSS.TrackComputedStyleUpdatesRequest): Promise; /** * Polls the next batch of computed style updates. */ invoke_takeComputedStyleUpdates(): Promise; /** * Find a rule with the given active property for the given node and set the new value for this * property */ invoke_setEffectivePropertyValueForNode(params: Protocol.CSS.SetEffectivePropertyValueForNodeRequest): Promise; /** * Modifies the property rule property name. */ invoke_setPropertyRulePropertyName(params: Protocol.CSS.SetPropertyRulePropertyNameRequest): Promise; /** * Modifies the keyframe rule key text. */ invoke_setKeyframeKey(params: Protocol.CSS.SetKeyframeKeyRequest): Promise; /** * Modifies the rule selector. */ invoke_setMediaText(params: Protocol.CSS.SetMediaTextRequest): Promise; /** * Modifies the expression of a container query. * Deprecated. Use setContainerQueryConditionText instead. * @deprecated */ invoke_setContainerQueryText(params: Protocol.CSS.SetContainerQueryTextRequest): Promise; invoke_setContainerQueryConditionText(params: Protocol.CSS.SetContainerQueryConditionTextRequest): Promise; /** * Modifies the expression of a supports at-rule. */ invoke_setSupportsText(params: Protocol.CSS.SetSupportsTextRequest): Promise; /** * Modifies the expression of a navigation at-rule. */ invoke_setNavigationText(params: Protocol.CSS.SetNavigationTextRequest): Promise; /** * Modifies the expression of a scope at-rule. */ invoke_setScopeText(params: Protocol.CSS.SetScopeTextRequest): Promise; /** * Modifies the rule selector. */ invoke_setRuleSelector(params: Protocol.CSS.SetRuleSelectorRequest): Promise; /** * Sets the new stylesheet text. */ invoke_setStyleSheetText(params: Protocol.CSS.SetStyleSheetTextRequest): Promise; /** * Applies specified style edits one after another in the given order. */ invoke_setStyleTexts(params: Protocol.CSS.SetStyleTextsRequest): Promise; /** * Enables the selector recording. */ invoke_startRuleUsageTracking(): Promise; /** * Stop tracking rule usage and return the list of rules that were used since last call to * `takeCoverageDelta` (or since start of coverage instrumentation). */ invoke_stopRuleUsageTracking(): Promise; /** * Obtain list of rules that became used since last call to this method (or since start of coverage * instrumentation). */ invoke_takeCoverageDelta(): Promise; /** * Enables/disables rendering of local CSS fonts (enabled by default). */ invoke_setLocalFontsEnabled(params: Protocol.CSS.SetLocalFontsEnabledRequest): Promise; } export interface CSSDispatcher { /** * Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded * web font. */ fontsUpdated(params: Protocol.CSS.FontsUpdatedEvent): void; /** * Fires whenever a MediaQuery result changes (for example, after a browser window has been * resized.) The current implementation considers only viewport-dependent media features. */ mediaQueryResultChanged(): void; /** * Fired whenever an active document stylesheet is added. */ styleSheetAdded(params: Protocol.CSS.StyleSheetAddedEvent): void; /** * Fired whenever a stylesheet is changed as a result of the client operation. */ styleSheetChanged(params: Protocol.CSS.StyleSheetChangedEvent): void; /** * Fired whenever an active document stylesheet is removed. */ styleSheetRemoved(params: Protocol.CSS.StyleSheetRemovedEvent): void; computedStyleUpdated(params: Protocol.CSS.ComputedStyleUpdatedEvent): void; } export interface CacheStorageApi { /** * Deletes a cache. */ invoke_deleteCache(params: Protocol.CacheStorage.DeleteCacheRequest): Promise; /** * Deletes a cache entry. */ invoke_deleteEntry(params: Protocol.CacheStorage.DeleteEntryRequest): Promise; /** * Requests cache names. */ invoke_requestCacheNames(params: Protocol.CacheStorage.RequestCacheNamesRequest): Promise; /** * Fetches cache entry. */ invoke_requestCachedResponse(params: Protocol.CacheStorage.RequestCachedResponseRequest): Promise; /** * Requests data from cache. */ invoke_requestEntries(params: Protocol.CacheStorage.RequestEntriesRequest): Promise; } export interface CacheStorageDispatcher { } export interface CastApi { /** * Starts observing for sinks that can be used for tab mirroring, and if set, * sinks compatible with |presentationUrl| as well. When sinks are found, a * |sinksUpdated| event is fired. * Also starts observing for issue messages. When an issue is added or removed, * an |issueUpdated| event is fired. */ invoke_enable(params: Protocol.Cast.EnableRequest): Promise; /** * Stops observing for sinks and issues. */ invoke_disable(): Promise; /** * Sets a sink to be used when the web page requests the browser to choose a * sink via Presentation API, Remote Playback API, or Cast SDK. */ invoke_setSinkToUse(params: Protocol.Cast.SetSinkToUseRequest): Promise; /** * Starts mirroring the desktop to the sink. */ invoke_startDesktopMirroring(params: Protocol.Cast.StartDesktopMirroringRequest): Promise; /** * Starts mirroring the tab to the sink. */ invoke_startTabMirroring(params: Protocol.Cast.StartTabMirroringRequest): Promise; /** * Stops the active Cast session on the sink. */ invoke_stopCasting(params: Protocol.Cast.StopCastingRequest): Promise; } export interface CastDispatcher { /** * This is fired whenever the list of available sinks changes. A sink is a * device or a software surface that you can cast to. */ sinksUpdated(params: Protocol.Cast.SinksUpdatedEvent): void; /** * This is fired whenever the outstanding issue/error message changes. * |issueMessage| is empty if there is no issue. */ issueUpdated(params: Protocol.Cast.IssueUpdatedEvent): void; } export interface CrashReportContextApi { /** * Returns all entries in the CrashReportContext across all frames in the page. */ invoke_getEntries(): Promise; } export interface CrashReportContextDispatcher { } export interface DOMApi { /** * Collects class names for the node with given id and all of it's child nodes. */ invoke_collectClassNamesFromSubtree(params: Protocol.DOM.CollectClassNamesFromSubtreeRequest): Promise; /** * Creates a deep copy of the specified node and places it into the target container before the * given anchor. */ invoke_copyTo(params: Protocol.DOM.CopyToRequest): Promise; /** * Describes node given its id, does not require domain to be enabled. Does not start tracking any * objects, can be used for automation. */ invoke_describeNode(params: Protocol.DOM.DescribeNodeRequest): Promise; /** * Scrolls the specified rect of the given node into view if not already visible. * Note: exactly one between nodeId, backendNodeId and objectId should be passed * to identify the node. */ invoke_scrollIntoViewIfNeeded(params: Protocol.DOM.ScrollIntoViewIfNeededRequest): Promise; /** * Disables DOM agent for the given page. */ invoke_disable(): Promise; /** * Discards search results from the session with the given id. `getSearchResults` should no longer * be called for that search. */ invoke_discardSearchResults(params: Protocol.DOM.DiscardSearchResultsRequest): Promise; /** * Enables DOM agent for the given page. */ invoke_enable(params: Protocol.DOM.EnableRequest): Promise; /** * Focuses the given element. */ invoke_focus(params: Protocol.DOM.FocusRequest): Promise; /** * Returns attributes for the specified node. */ invoke_getAttributes(params: Protocol.DOM.GetAttributesRequest): Promise; /** * Returns boxes for the given node. */ invoke_getBoxModel(params: Protocol.DOM.GetBoxModelRequest): Promise; /** * Returns quads that describe node position on the page. This method * might return multiple quads for inline nodes. */ invoke_getContentQuads(params: Protocol.DOM.GetContentQuadsRequest): Promise; /** * Returns the root DOM node (and optionally the subtree) to the caller. * Implicitly enables the DOM domain events for the current target. */ invoke_getDocument(params: Protocol.DOM.GetDocumentRequest): Promise; /** * Returns the root DOM node (and optionally the subtree) to the caller. * Deprecated, as it is not designed to work well with the rest of the DOM agent. * Use DOMSnapshot.captureSnapshot instead. * @deprecated */ invoke_getFlattenedDocument(params: Protocol.DOM.GetFlattenedDocumentRequest): Promise; /** * Finds nodes with a given computed style in a subtree. */ invoke_getNodesForSubtreeByStyle(params: Protocol.DOM.GetNodesForSubtreeByStyleRequest): Promise; /** * Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is * either returned or not. */ invoke_getNodeForLocation(params: Protocol.DOM.GetNodeForLocationRequest): Promise; /** * Returns node's HTML markup. */ invoke_getOuterHTML(params: Protocol.DOM.GetOuterHTMLRequest): Promise; /** * Returns the id of the nearest ancestor that is a relayout boundary. */ invoke_getRelayoutBoundary(params: Protocol.DOM.GetRelayoutBoundaryRequest): Promise; /** * Returns search results from given `fromIndex` to given `toIndex` from the search with the given * identifier. */ invoke_getSearchResults(params: Protocol.DOM.GetSearchResultsRequest): Promise; /** * Hides any highlight. */ invoke_hideHighlight(): Promise; /** * Highlights DOM node. */ invoke_highlightNode(): Promise; /** * Highlights given rectangle. */ invoke_highlightRect(): Promise; /** * Marks last undoable state. */ invoke_markUndoableState(): Promise; /** * Moves node into the new container, places it before the given anchor. */ invoke_moveTo(params: Protocol.DOM.MoveToRequest): Promise; /** * Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or * `cancelSearch` to end this search session. */ invoke_performSearch(params: Protocol.DOM.PerformSearchRequest): Promise; /** * Requests that the node is sent to the caller given its path. // FIXME, use XPath */ invoke_pushNodeByPathToFrontend(params: Protocol.DOM.PushNodeByPathToFrontendRequest): Promise; /** * Requests that a batch of nodes is sent to the caller given their backend node ids. */ invoke_pushNodesByBackendIdsToFrontend(params: Protocol.DOM.PushNodesByBackendIdsToFrontendRequest): Promise; /** * Executes `querySelector` on a given node. */ invoke_querySelector(params: Protocol.DOM.QuerySelectorRequest): Promise; /** * Executes `querySelectorAll` on a given node. */ invoke_querySelectorAll(params: Protocol.DOM.QuerySelectorAllRequest): Promise; /** * Returns NodeIds of current top layer elements. * Top layer is rendered closest to the user within a viewport, therefore its elements always * appear on top of all other content. */ invoke_getTopLayerElements(): Promise; /** * Returns the NodeId of the matched element according to certain relations. */ invoke_getElementByRelation(params: Protocol.DOM.GetElementByRelationRequest): Promise; /** * Re-does the last undone action. */ invoke_redo(): Promise; /** * Removes attribute with given name from an element with given id. */ invoke_removeAttribute(params: Protocol.DOM.RemoveAttributeRequest): Promise; /** * Removes node with given id. */ invoke_removeNode(params: Protocol.DOM.RemoveNodeRequest): Promise; /** * Requests that children of the node with given id are returned to the caller in form of * `setChildNodes` events where not only immediate children are retrieved, but all children down to * the specified depth. */ invoke_requestChildNodes(params: Protocol.DOM.RequestChildNodesRequest): Promise; /** * Requests that the node is sent to the caller given the JavaScript node object reference. All * nodes that form the path from the node to the root are also sent to the client as a series of * `setChildNodes` notifications. */ invoke_requestNode(params: Protocol.DOM.RequestNodeRequest): Promise; /** * Resolves the JavaScript node object for a given NodeId or BackendNodeId. */ invoke_resolveNode(params: Protocol.DOM.ResolveNodeRequest): Promise; /** * Sets attribute for an element with given id. */ invoke_setAttributeValue(params: Protocol.DOM.SetAttributeValueRequest): Promise; /** * Sets attributes on element with given id. This method is useful when user edits some existing * attribute value and types in several attribute name/value pairs. */ invoke_setAttributesAsText(params: Protocol.DOM.SetAttributesAsTextRequest): Promise; /** * Sets files for the given file input element. */ invoke_setFileInputFiles(params: Protocol.DOM.SetFileInputFilesRequest): Promise; /** * Sets if stack traces should be captured for Nodes. See `Node.getNodeStackTraces`. Default is disabled. */ invoke_setNodeStackTracesEnabled(params: Protocol.DOM.SetNodeStackTracesEnabledRequest): Promise; /** * Gets stack traces associated with a Node. As of now, only provides stack trace for Node creation. */ invoke_getNodeStackTraces(params: Protocol.DOM.GetNodeStackTracesRequest): Promise; /** * Returns file information for the given * File wrapper. */ invoke_getFileInfo(params: Protocol.DOM.GetFileInfoRequest): Promise; /** * Returns list of detached nodes */ invoke_getDetachedDomNodes(): Promise; /** * Enables console to refer to the node with given id via $x (see Command Line API for more details * $x functions). */ invoke_setInspectedNode(params: Protocol.DOM.SetInspectedNodeRequest): Promise; /** * Sets node name for a node with given id. */ invoke_setNodeName(params: Protocol.DOM.SetNodeNameRequest): Promise; /** * Sets node value for a node with given id. */ invoke_setNodeValue(params: Protocol.DOM.SetNodeValueRequest): Promise; /** * Sets node HTML markup, returns new node id. */ invoke_setOuterHTML(params: Protocol.DOM.SetOuterHTMLRequest): Promise; /** * Undoes the last performed action. */ invoke_undo(): Promise; /** * Returns iframe node that owns iframe with the given domain. */ invoke_getFrameOwner(params: Protocol.DOM.GetFrameOwnerRequest): Promise; /** * Returns the query container of the given node based on container query * conditions: containerName, physical and logical axes, and whether it queries * scroll-state or anchored elements. If no axes are provided and * queriesScrollState is false, the style container is returned, which is the * direct parent or the closest element with a matching container-name. */ invoke_getContainerForNode(params: Protocol.DOM.GetContainerForNodeRequest): Promise; /** * Returns the descendants of a container query container that have * container queries against this container. */ invoke_getQueryingDescendantsForContainer(params: Protocol.DOM.GetQueryingDescendantsForContainerRequest): Promise; /** * Returns the target anchor element of the given anchor query according to * https://www.w3.org/TR/css-anchor-position-1/#target. */ invoke_getAnchorElement(params: Protocol.DOM.GetAnchorElementRequest): Promise; /** * When enabling, this API force-opens the popover identified by nodeId * and keeps it open until disabled. */ invoke_forceShowPopover(params: Protocol.DOM.ForceShowPopoverRequest): Promise; } export interface DOMDispatcher { /** * Fired when `Element`'s attribute is modified. */ attributeModified(params: Protocol.DOM.AttributeModifiedEvent): void; /** * Fired when `Element`'s adoptedStyleSheets are modified. */ adoptedStyleSheetsModified(params: Protocol.DOM.AdoptedStyleSheetsModifiedEvent): void; /** * Fired when `Element`'s attribute is removed. */ attributeRemoved(params: Protocol.DOM.AttributeRemovedEvent): void; /** * Mirrors `DOMCharacterDataModified` event. */ characterDataModified(params: Protocol.DOM.CharacterDataModifiedEvent): void; /** * Fired when `Container`'s child node count has changed. */ childNodeCountUpdated(params: Protocol.DOM.ChildNodeCountUpdatedEvent): void; /** * Mirrors `DOMNodeInserted` event. */ childNodeInserted(params: Protocol.DOM.ChildNodeInsertedEvent): void; /** * Mirrors `DOMNodeRemoved` event. */ childNodeRemoved(params: Protocol.DOM.ChildNodeRemovedEvent): void; /** * Called when distribution is changed. */ distributedNodesUpdated(params: Protocol.DOM.DistributedNodesUpdatedEvent): void; /** * Fired when `Document` has been totally updated. Node ids are no longer valid. */ documentUpdated(): void; /** * Fired when `Element`'s inline style is modified via a CSS property modification. */ inlineStyleInvalidated(params: Protocol.DOM.InlineStyleInvalidatedEvent): void; /** * Called when a pseudo element is added to an element. */ pseudoElementAdded(params: Protocol.DOM.PseudoElementAddedEvent): void; /** * Called when top layer elements are changed. */ topLayerElementsUpdated(): void; /** * Fired when a node's scrollability state changes. */ scrollableFlagUpdated(params: Protocol.DOM.ScrollableFlagUpdatedEvent): void; /** * Fired when a node's ad related state changes. */ adRelatedStateUpdated(params: Protocol.DOM.AdRelatedStateUpdatedEvent): void; /** * Fired when a node's starting styles changes. */ affectedByStartingStylesFlagUpdated(params: Protocol.DOM.AffectedByStartingStylesFlagUpdatedEvent): void; /** * Called when a pseudo element is removed from an element. */ pseudoElementRemoved(params: Protocol.DOM.PseudoElementRemovedEvent): void; /** * Fired when backend wants to provide client with the missing DOM structure. This happens upon * most of the calls requesting node ids. */ setChildNodes(params: Protocol.DOM.SetChildNodesEvent): void; /** * Called when shadow root is popped from the element. */ shadowRootPopped(params: Protocol.DOM.ShadowRootPoppedEvent): void; /** * Called when shadow root is pushed into the element. */ shadowRootPushed(params: Protocol.DOM.ShadowRootPushedEvent): void; } export interface DOMDebuggerApi { /** * Returns event listeners of the given object. */ invoke_getEventListeners(params: Protocol.DOMDebugger.GetEventListenersRequest): Promise; /** * Removes DOM breakpoint that was set using `setDOMBreakpoint`. */ invoke_removeDOMBreakpoint(params: Protocol.DOMDebugger.RemoveDOMBreakpointRequest): Promise; /** * Removes breakpoint on particular DOM event. */ invoke_removeEventListenerBreakpoint(params: Protocol.DOMDebugger.RemoveEventListenerBreakpointRequest): Promise; /** * Removes breakpoint on particular native event. * @deprecated */ invoke_removeInstrumentationBreakpoint(params: Protocol.DOMDebugger.RemoveInstrumentationBreakpointRequest): Promise; /** * Removes breakpoint from XMLHttpRequest. */ invoke_removeXHRBreakpoint(params: Protocol.DOMDebugger.RemoveXHRBreakpointRequest): Promise; /** * Sets breakpoint on particular CSP violations. */ invoke_setBreakOnCSPViolation(params: Protocol.DOMDebugger.SetBreakOnCSPViolationRequest): Promise; /** * Sets breakpoint on particular operation with DOM. */ invoke_setDOMBreakpoint(params: Protocol.DOMDebugger.SetDOMBreakpointRequest): Promise; /** * Sets breakpoint on particular DOM event. */ invoke_setEventListenerBreakpoint(params: Protocol.DOMDebugger.SetEventListenerBreakpointRequest): Promise; /** * Sets breakpoint on particular native event. * @deprecated */ invoke_setInstrumentationBreakpoint(params: Protocol.DOMDebugger.SetInstrumentationBreakpointRequest): Promise; /** * Sets breakpoint on XMLHttpRequest. */ invoke_setXHRBreakpoint(params: Protocol.DOMDebugger.SetXHRBreakpointRequest): Promise; } export interface DOMDebuggerDispatcher { } export interface DOMSnapshotApi { /** * Disables DOM snapshot agent for the given page. */ invoke_disable(): Promise; /** * Enables DOM snapshot agent for the given page. */ invoke_enable(): Promise; /** * Returns a document snapshot, including the full DOM tree of the root node (including iframes, * template contents, and imported documents) in a flattened array, as well as layout and * white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is * flattened. * @deprecated */ invoke_getSnapshot(params: Protocol.DOMSnapshot.GetSnapshotRequest): Promise; /** * Returns a document snapshot, including the full DOM tree of the root node (including iframes, * template contents, and imported documents) in a flattened array, as well as layout and * white-listed computed style information for the nodes. Shadow DOM in the returned DOM tree is * flattened. */ invoke_captureSnapshot(params: Protocol.DOMSnapshot.CaptureSnapshotRequest): Promise; } export interface DOMSnapshotDispatcher { } export interface DOMStorageApi { invoke_clear(params: Protocol.DOMStorage.ClearRequest): Promise; /** * Disables storage tracking, prevents storage events from being sent to the client. */ invoke_disable(): Promise; /** * Enables storage tracking, storage events will now be delivered to the client. */ invoke_enable(): Promise; invoke_getDOMStorageItems(params: Protocol.DOMStorage.GetDOMStorageItemsRequest): Promise; invoke_removeDOMStorageItem(params: Protocol.DOMStorage.RemoveDOMStorageItemRequest): Promise; invoke_setDOMStorageItem(params: Protocol.DOMStorage.SetDOMStorageItemRequest): Promise; } export interface DOMStorageDispatcher { domStorageItemAdded(params: Protocol.DOMStorage.DomStorageItemAddedEvent): void; domStorageItemRemoved(params: Protocol.DOMStorage.DomStorageItemRemovedEvent): void; domStorageItemUpdated(params: Protocol.DOMStorage.DomStorageItemUpdatedEvent): void; domStorageItemsCleared(params: Protocol.DOMStorage.DomStorageItemsClearedEvent): void; } export interface DeviceAccessApi { /** * Enable events in this domain. */ invoke_enable(): Promise; /** * Disable events in this domain. */ invoke_disable(): Promise; /** * Select a device in response to a DeviceAccess.deviceRequestPrompted event. */ invoke_selectPrompt(params: Protocol.DeviceAccess.SelectPromptRequest): Promise; /** * Cancel a prompt in response to a DeviceAccess.deviceRequestPrompted event. */ invoke_cancelPrompt(params: Protocol.DeviceAccess.CancelPromptRequest): Promise; } export interface DeviceAccessDispatcher { /** * A device request opened a user prompt to select a device. Respond with the * selectPrompt or cancelPrompt command. */ deviceRequestPrompted(params: Protocol.DeviceAccess.DeviceRequestPromptedEvent): void; } export interface DeviceOrientationApi { /** * Clears the overridden Device Orientation. */ invoke_clearDeviceOrientationOverride(): Promise; /** * Overrides the Device Orientation. */ invoke_setDeviceOrientationOverride(params: Protocol.DeviceOrientation.SetDeviceOrientationOverrideRequest): Promise; } export interface DeviceOrientationDispatcher { } export interface EmulationApi { /** * Tells whether emulation is supported. * @deprecated */ invoke_canEmulate(): Promise; /** * Clears the overridden device metrics. */ invoke_clearDeviceMetricsOverride(): Promise; /** * Clears the overridden Geolocation Position and Error. */ invoke_clearGeolocationOverride(): Promise; /** * Requests that page scale factor is reset to initial values. */ invoke_resetPageScaleFactor(): Promise; /** * Enables or disables simulating a focused and active page. */ invoke_setFocusEmulationEnabled(params: Protocol.Emulation.SetFocusEmulationEnabledRequest): Promise; /** * Automatically render all web contents using a dark theme. */ invoke_setAutoDarkModeOverride(params: Protocol.Emulation.SetAutoDarkModeOverrideRequest): Promise; /** * Enables CPU throttling to emulate slow CPUs. */ invoke_setCPUThrottlingRate(params: Protocol.Emulation.SetCPUThrottlingRateRequest): Promise; /** * Sets or clears an override of the default background color of the frame. This override is used * if the content does not specify one. */ invoke_setDefaultBackgroundColorOverride(params: Protocol.Emulation.SetDefaultBackgroundColorOverrideRequest): Promise; /** * Overrides the values for env(safe-area-inset-*) and env(safe-area-max-inset-*). Unset values will cause the * respective variables to be undefined, even if previously overridden. */ invoke_setSafeAreaInsetsOverride(params: Protocol.Emulation.SetSafeAreaInsetsOverrideRequest): Promise; /** * Overrides the values of device screen dimensions (window.screen.width, window.screen.height, * window.innerWidth, window.innerHeight, and "device-width"/"device-height"-related CSS media * query results). */ invoke_setDeviceMetricsOverride(params: Protocol.Emulation.SetDeviceMetricsOverrideRequest): Promise; /** * Start reporting the given posture value to the Device Posture API. * This override can also be set in setDeviceMetricsOverride(). */ invoke_setDevicePostureOverride(params: Protocol.Emulation.SetDevicePostureOverrideRequest): Promise; /** * Clears a device posture override set with either setDeviceMetricsOverride() * or setDevicePostureOverride() and starts using posture information from the * platform again. * Does nothing if no override is set. */ invoke_clearDevicePostureOverride(): Promise; /** * Start using the given display features to pupulate the Viewport Segments API. * This override can also be set in setDeviceMetricsOverride(). */ invoke_setDisplayFeaturesOverride(params: Protocol.Emulation.SetDisplayFeaturesOverrideRequest): Promise; /** * Clears the display features override set with either setDeviceMetricsOverride() * or setDisplayFeaturesOverride() and starts using display features from the * platform again. * Does nothing if no override is set. */ invoke_clearDisplayFeaturesOverride(): Promise; invoke_setScrollbarsHidden(params: Protocol.Emulation.SetScrollbarsHiddenRequest): Promise; invoke_setDocumentCookieDisabled(params: Protocol.Emulation.SetDocumentCookieDisabledRequest): Promise; invoke_setEmitTouchEventsForMouse(params: Protocol.Emulation.SetEmitTouchEventsForMouseRequest): Promise; /** * Emulates the given media type or media feature for CSS media queries. */ invoke_setEmulatedMedia(params: Protocol.Emulation.SetEmulatedMediaRequest): Promise; /** * Emulates the given vision deficiency. */ invoke_setEmulatedVisionDeficiency(params: Protocol.Emulation.SetEmulatedVisionDeficiencyRequest): Promise; /** * Emulates the given OS text scale. */ invoke_setEmulatedOSTextScale(params: Protocol.Emulation.SetEmulatedOSTextScaleRequest): Promise; /** * Overrides the Geolocation Position or Error. Omitting latitude, longitude or * accuracy emulates position unavailable. */ invoke_setGeolocationOverride(params: Protocol.Emulation.SetGeolocationOverrideRequest): Promise; invoke_getOverriddenSensorInformation(params: Protocol.Emulation.GetOverriddenSensorInformationRequest): Promise; /** * Overrides a platform sensor of a given type. If |enabled| is true, calls to * Sensor.start() will use a virtual sensor as backend rather than fetching * data from a real hardware sensor. Otherwise, existing virtual * sensor-backend Sensor objects will fire an error event and new calls to * Sensor.start() will attempt to use a real sensor instead. */ invoke_setSensorOverrideEnabled(params: Protocol.Emulation.SetSensorOverrideEnabledRequest): Promise; /** * Updates the sensor readings reported by a sensor type previously overridden * by setSensorOverrideEnabled. */ invoke_setSensorOverrideReadings(params: Protocol.Emulation.SetSensorOverrideReadingsRequest): Promise; /** * Overrides a pressure source of a given type, as used by the Compute * Pressure API, so that updates to PressureObserver.observe() are provided * via setPressureStateOverride instead of being retrieved from * platform-provided telemetry data. */ invoke_setPressureSourceOverrideEnabled(params: Protocol.Emulation.SetPressureSourceOverrideEnabledRequest): Promise; /** * TODO: OBSOLETE: To remove when setPressureDataOverride is merged. * Provides a given pressure state that will be processed and eventually be * delivered to PressureObserver users. |source| must have been previously * overridden by setPressureSourceOverrideEnabled. */ invoke_setPressureStateOverride(params: Protocol.Emulation.SetPressureStateOverrideRequest): Promise; /** * Provides a given pressure data set that will be processed and eventually be * delivered to PressureObserver users. |source| must have been previously * overridden by setPressureSourceOverrideEnabled. */ invoke_setPressureDataOverride(params: Protocol.Emulation.SetPressureDataOverrideRequest): Promise; /** * Overrides the Idle state. */ invoke_setIdleOverride(params: Protocol.Emulation.SetIdleOverrideRequest): Promise; /** * Clears Idle state overrides. */ invoke_clearIdleOverride(): Promise; /** * Overrides value returned by the javascript navigator object. * @deprecated */ invoke_setNavigatorOverrides(params: Protocol.Emulation.SetNavigatorOverridesRequest): Promise; /** * Sets a specified page scale factor. */ invoke_setPageScaleFactor(params: Protocol.Emulation.SetPageScaleFactorRequest): Promise; /** * Switches script execution in the page. */ invoke_setScriptExecutionDisabled(params: Protocol.Emulation.SetScriptExecutionDisabledRequest): Promise; /** * Enables touch on platforms which do not support them. */ invoke_setTouchEmulationEnabled(params: Protocol.Emulation.SetTouchEmulationEnabledRequest): Promise; /** * Turns on virtual time for all frames (replacing real-time with a synthetic time source) and sets * the current virtual time policy. Note this supersedes any previous time budget. */ invoke_setVirtualTimePolicy(params: Protocol.Emulation.SetVirtualTimePolicyRequest): Promise; /** * Overrides default host system locale with the specified one. */ invoke_setLocaleOverride(params: Protocol.Emulation.SetLocaleOverrideRequest): Promise; /** * Overrides default host system timezone with the specified one. */ invoke_setTimezoneOverride(params: Protocol.Emulation.SetTimezoneOverrideRequest): Promise; /** * Resizes the frame/viewport of the page. Note that this does not affect the frame's container * (e.g. browser window). Can be used to produce screenshots of the specified size. Not supported * on Android. * @deprecated */ invoke_setVisibleSize(params: Protocol.Emulation.SetVisibleSizeRequest): Promise; invoke_setDisabledImageTypes(params: Protocol.Emulation.SetDisabledImageTypesRequest): Promise; /** * Override the value of navigator.connection.saveData */ invoke_setDataSaverOverride(params: Protocol.Emulation.SetDataSaverOverrideRequest): Promise; invoke_setHardwareConcurrencyOverride(params: Protocol.Emulation.SetHardwareConcurrencyOverrideRequest): Promise; /** * Allows overriding user agent with the given string. * `userAgentMetadata` must be set for Client Hint headers to be sent. */ invoke_setUserAgentOverride(params: Protocol.Emulation.SetUserAgentOverrideRequest): Promise; /** * Allows overriding the automation flag. */ invoke_setAutomationOverride(params: Protocol.Emulation.SetAutomationOverrideRequest): Promise; /** * Allows overriding the difference between the small and large viewport sizes, which determine the * value of the `svh` and `lvh` unit, respectively. Only supported for top-level frames. */ invoke_setSmallViewportHeightDifferenceOverride(params: Protocol.Emulation.SetSmallViewportHeightDifferenceOverrideRequest): Promise; /** * Returns device's screen configuration. In headful mode, the physical screens configuration is returned, * whereas in headless mode, a virtual headless screen configuration is provided instead. */ invoke_getScreenInfos(): Promise; /** * Add a new screen to the device. Only supported in headless mode. */ invoke_addScreen(params: Protocol.Emulation.AddScreenRequest): Promise; /** * Updates specified screen parameters. Only supported in headless mode. */ invoke_updateScreen(params: Protocol.Emulation.UpdateScreenRequest): Promise; /** * Remove screen from the device. Only supported in headless mode. */ invoke_removeScreen(params: Protocol.Emulation.RemoveScreenRequest): Promise; /** * Set primary screen. Only supported in headless mode. * Note that this changes the coordinate system origin to the top-left * of the new primary screen, updating the bounds and work areas * of all existing screens accordingly. */ invoke_setPrimaryScreen(params: Protocol.Emulation.SetPrimaryScreenRequest): Promise; } export interface EmulationDispatcher { /** * Notification sent after the virtual time budget for the current VirtualTimePolicy has run out. */ virtualTimeBudgetExpired(): void; /** * Fired when a page calls screen.orientation.lock() or screen.orientation.unlock() * while device emulation is enabled. This allows the DevTools frontend to update the * emulated device orientation accordingly. */ screenOrientationLockChanged(params: Protocol.Emulation.ScreenOrientationLockChangedEvent): void; } export interface EventBreakpointsApi { /** * Sets breakpoint on particular native event. */ invoke_setInstrumentationBreakpoint(params: Protocol.EventBreakpoints.SetInstrumentationBreakpointRequest): Promise; /** * Removes breakpoint on particular native event. */ invoke_removeInstrumentationBreakpoint(params: Protocol.EventBreakpoints.RemoveInstrumentationBreakpointRequest): Promise; /** * Removes all breakpoints */ invoke_disable(): Promise; } export interface EventBreakpointsDispatcher { } export interface ExtensionsApi { /** * Runs an extension default action. */ invoke_triggerAction(params: Protocol.Extensions.TriggerActionRequest): Promise; /** * Installs an unpacked extension from the filesystem similar to * --load-extension CLI flags. Returns extension ID once the extension * has been installed. */ invoke_loadUnpacked(params: Protocol.Extensions.LoadUnpackedRequest): Promise; /** * Gets a list of all unpacked extensions. */ invoke_getExtensions(): Promise; /** * Uninstalls an unpacked extension (others not supported) from the profile. */ invoke_uninstall(params: Protocol.Extensions.UninstallRequest): Promise; /** * Gets data from extension storage in the given `storageArea`. If `keys` is * specified, these are used to filter the result. */ invoke_getStorageItems(params: Protocol.Extensions.GetStorageItemsRequest): Promise; /** * Removes `keys` from extension storage in the given `storageArea`. */ invoke_removeStorageItems(params: Protocol.Extensions.RemoveStorageItemsRequest): Promise; /** * Clears extension storage in the given `storageArea`. */ invoke_clearStorageItems(params: Protocol.Extensions.ClearStorageItemsRequest): Promise; /** * Sets `values` in extension storage in the given `storageArea`. The provided `values` * will be merged with existing values in the storage area. */ invoke_setStorageItems(params: Protocol.Extensions.SetStorageItemsRequest): Promise; } export interface ExtensionsDispatcher { } export interface FedCmApi { invoke_enable(params: Protocol.FedCm.EnableRequest): Promise; invoke_disable(): Promise; invoke_selectAccount(params: Protocol.FedCm.SelectAccountRequest): Promise; invoke_clickDialogButton(params: Protocol.FedCm.ClickDialogButtonRequest): Promise; invoke_openUrl(params: Protocol.FedCm.OpenUrlRequest): Promise; invoke_dismissDialog(params: Protocol.FedCm.DismissDialogRequest): Promise; /** * Resets the cooldown time, if any, to allow the next FedCM call to show * a dialog even if one was recently dismissed by the user. */ invoke_resetCooldown(): Promise; } export interface FedCmDispatcher { dialogShown(params: Protocol.FedCm.DialogShownEvent): void; /** * Triggered when a dialog is closed, either by user action, JS abort, * or a command below. */ dialogClosed(params: Protocol.FedCm.DialogClosedEvent): void; } export interface FetchApi { /** * Disables the fetch domain. */ invoke_disable(): Promise; /** * Enables issuing of requestPaused events. A request will be paused until client * calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth. */ invoke_enable(params: Protocol.Fetch.EnableRequest): Promise; /** * Causes the request to fail with specified reason. */ invoke_failRequest(params: Protocol.Fetch.FailRequestRequest): Promise; /** * Provides response to the request. */ invoke_fulfillRequest(params: Protocol.Fetch.FulfillRequestRequest): Promise; /** * Continues the request, optionally modifying some of its parameters. */ invoke_continueRequest(params: Protocol.Fetch.ContinueRequestRequest): Promise; /** * Continues a request supplying authChallengeResponse following authRequired event. */ invoke_continueWithAuth(params: Protocol.Fetch.ContinueWithAuthRequest): Promise; /** * Continues loading of the paused response, optionally modifying the * response headers. If either responseCode or headers are modified, all of them * must be present. */ invoke_continueResponse(params: Protocol.Fetch.ContinueResponseRequest): Promise; /** * Causes the body of the response to be received from the server and * returned as a single string. May only be issued for a request that * is paused in the Response stage and is mutually exclusive with * takeResponseBodyForInterceptionAsStream. Calling other methods that * affect the request or disabling fetch domain before body is received * results in an undefined behavior. * Note that the response body is not available for redirects. Requests * paused in the _redirect received_ state may be differentiated by * `responseCode` and presence of `location` response header, see * comments to `requestPaused` for details. */ invoke_getResponseBody(params: Protocol.Fetch.GetResponseBodyRequest): Promise; /** * Returns a handle to the stream representing the response body. * The request must be paused in the HeadersReceived stage. * Note that after this command the request can't be continued * as is -- client either needs to cancel it or to provide the * response body. * The stream only supports sequential read, IO.read will fail if the position * is specified. * This method is mutually exclusive with getResponseBody. * Calling other methods that affect the request or disabling fetch * domain before body is received results in an undefined behavior. */ invoke_takeResponseBodyAsStream(params: Protocol.Fetch.TakeResponseBodyAsStreamRequest): Promise; } export interface FetchDispatcher { /** * Issued when the domain is enabled and the request URL matches the * specified filter. The request is paused until the client responds * with one of continueRequest, failRequest or fulfillRequest. * The stage of the request can be determined by presence of responseErrorReason * and responseStatusCode -- the request is at the response stage if either * of these fields is present and in the request stage otherwise. * Redirect responses and subsequent requests are reported similarly to regular * responses and requests. Redirect responses may be distinguished by the value * of `responseStatusCode` (which is one of 301, 302, 303, 307, 308) along with * presence of the `location` header. Requests resulting from a redirect will * have `redirectedRequestId` field set. */ requestPaused(params: Protocol.Fetch.RequestPausedEvent): void; /** * Issued when the domain is enabled with handleAuthRequests set to true. * The request is paused until client responds with continueWithAuth. */ authRequired(params: Protocol.Fetch.AuthRequiredEvent): void; } export interface FileSystemApi { invoke_getDirectory(params: Protocol.FileSystem.GetDirectoryRequest): Promise; } export interface FileSystemDispatcher { } export interface HeadlessExperimentalApi { /** * Sends a BeginFrame to the target and returns when the frame was completed. Optionally captures a * screenshot from the resulting frame. Requires that the target was created with enabled * BeginFrameControl. Designed for use with --run-all-compositor-stages-before-draw, see also * https://goo.gle/chrome-headless-rendering for more background. */ invoke_beginFrame(params: Protocol.HeadlessExperimental.BeginFrameRequest): Promise; /** * Disables headless events for the target. * @deprecated */ invoke_disable(): Promise; /** * Enables headless events for the target. * @deprecated */ invoke_enable(): Promise; } export interface HeadlessExperimentalDispatcher { } // eslint thinks this is us prefixing our interfaces but it's not! // eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface IOApi { /** * Close the stream, discard any temporary backing storage. */ invoke_close(params: Protocol.IO.CloseRequest): Promise; /** * Read a chunk of the stream */ invoke_read(params: Protocol.IO.ReadRequest): Promise; /** * Return UUID of Blob object specified by a remote object id. */ invoke_resolveBlob(params: Protocol.IO.ResolveBlobRequest): Promise; } export interface IODispatcher { } // eslint thinks this is us prefixing our interfaces but it's not! // eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface IndexedDBApi { /** * Clears all entries from an object store. */ invoke_clearObjectStore(params: Protocol.IndexedDB.ClearObjectStoreRequest): Promise; /** * Deletes a database. */ invoke_deleteDatabase(params: Protocol.IndexedDB.DeleteDatabaseRequest): Promise; /** * Delete a range of entries from an object store */ invoke_deleteObjectStoreEntries(params: Protocol.IndexedDB.DeleteObjectStoreEntriesRequest): Promise; /** * Disables events from backend. */ invoke_disable(): Promise; /** * Enables events from backend. */ invoke_enable(): Promise; /** * Requests data from object store or index. */ invoke_requestData(params: Protocol.IndexedDB.RequestDataRequest): Promise; /** * Gets metadata of an object store. */ invoke_getMetadata(params: Protocol.IndexedDB.GetMetadataRequest): Promise; /** * Requests database with given name in given frame. */ invoke_requestDatabase(params: Protocol.IndexedDB.RequestDatabaseRequest): Promise; /** * Requests database names for given security origin. */ invoke_requestDatabaseNames(params: Protocol.IndexedDB.RequestDatabaseNamesRequest): Promise; } export interface IndexedDBDispatcher { } // eslint thinks this is us prefixing our interfaces but it's not! // eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface InputApi { /** * Dispatches a drag event into the page. */ invoke_dispatchDragEvent(params: Protocol.Input.DispatchDragEventRequest): Promise; /** * Dispatches a key event to the page. */ invoke_dispatchKeyEvent(params: Protocol.Input.DispatchKeyEventRequest): Promise; /** * This method emulates inserting text that doesn't come from a key press, * for example an emoji keyboard or an IME. */ invoke_insertText(params: Protocol.Input.InsertTextRequest): Promise; /** * This method sets the current candidate text for IME. * Use imeCommitComposition to commit the final text. * Use imeSetComposition with empty string as text to cancel composition. */ invoke_imeSetComposition(params: Protocol.Input.ImeSetCompositionRequest): Promise; /** * Dispatches a mouse event to the page. */ invoke_dispatchMouseEvent(params: Protocol.Input.DispatchMouseEventRequest): Promise; /** * Dispatches a touch event to the page. */ invoke_dispatchTouchEvent(params: Protocol.Input.DispatchTouchEventRequest): Promise; /** * Cancels any active dragging in the page. */ invoke_cancelDragging(): Promise; /** * Emulates touch event from the mouse event parameters. */ invoke_emulateTouchFromMouseEvent(params: Protocol.Input.EmulateTouchFromMouseEventRequest): Promise; /** * Ignores input events (useful while auditing page). */ invoke_setIgnoreInputEvents(params: Protocol.Input.SetIgnoreInputEventsRequest): Promise; /** * Prevents default drag and drop behavior and instead emits `Input.dragIntercepted` events. * Drag and drop behavior can be directly controlled via `Input.dispatchDragEvent`. */ invoke_setInterceptDrags(params: Protocol.Input.SetInterceptDragsRequest): Promise; /** * Synthesizes a pinch gesture over a time period by issuing appropriate touch events. */ invoke_synthesizePinchGesture(params: Protocol.Input.SynthesizePinchGestureRequest): Promise; /** * Synthesizes a scroll gesture over a time period by issuing appropriate touch events. */ invoke_synthesizeScrollGesture(params: Protocol.Input.SynthesizeScrollGestureRequest): Promise; /** * Synthesizes a tap gesture over a time period by issuing appropriate touch events. */ invoke_synthesizeTapGesture(params: Protocol.Input.SynthesizeTapGestureRequest): Promise; } export interface InputDispatcher { /** * Emitted only when `Input.setInterceptDrags` is enabled. Use this data with `Input.dispatchDragEvent` to * restore normal drag and drop behavior. */ dragIntercepted(params: Protocol.Input.DragInterceptedEvent): void; } // eslint thinks this is us prefixing our interfaces but it's not! // eslint-disable-next-line @typescript-eslint/interface-name-prefix export interface InspectorApi { /** * Disables inspector domain notifications. */ invoke_disable(): Promise; /** * Enables inspector domain notifications. */ invoke_enable(): Promise; } export interface InspectorDispatcher { /** * Fired when remote debugging connection is about to be terminated. Contains detach reason. */ detached(params: Protocol.Inspector.DetachedEvent): void; /** * Fired when debugging target has crashed */ targetCrashed(): void; /** * Fired when debugging target has reloaded after crash */ targetReloadedAfterCrash(): void; /** * Fired on worker targets when main worker script and any imported scripts have been evaluated. */ workerScriptLoaded(): void; } export interface LayerTreeApi { /** * Provides the reasons why the given layer was composited. */ invoke_compositingReasons(params: Protocol.LayerTree.CompositingReasonsRequest): Promise; /** * Disables compositing tree inspection. */ invoke_disable(): Promise; /** * Enables compositing tree inspection. */ invoke_enable(): Promise; /** * Returns the snapshot identifier. */ invoke_loadSnapshot(params: Protocol.LayerTree.LoadSnapshotRequest): Promise; /** * Returns the layer snapshot identifier. */ invoke_makeSnapshot(params: Protocol.LayerTree.MakeSnapshotRequest): Promise; invoke_profileSnapshot(params: Protocol.LayerTree.ProfileSnapshotRequest): Promise; /** * Releases layer snapshot captured by the back-end. */ invoke_releaseSnapshot(params: Protocol.LayerTree.ReleaseSnapshotRequest): Promise; /** * Replays the layer snapshot and returns the resulting bitmap. */ invoke_replaySnapshot(params: Protocol.LayerTree.ReplaySnapshotRequest): Promise; /** * Replays the layer snapshot and returns canvas log. */ invoke_snapshotCommandLog(params: Protocol.LayerTree.SnapshotCommandLogRequest): Promise; } export interface LayerTreeDispatcher { layerPainted(params: Protocol.LayerTree.LayerPaintedEvent): void; layerTreeDidChange(params: Protocol.LayerTree.LayerTreeDidChangeEvent): void; } export interface LogApi { /** * Clears the log. */ invoke_clear(): Promise; /** * Disables log domain, prevents further log entries from being reported to the client. */ invoke_disable(): Promise; /** * Enables log domain, sends the entries collected so far to the client by means of the * `entryAdded` notification. */ invoke_enable(): Promise; /** * start violation reporting. */ invoke_startViolationsReport(params: Protocol.Log.StartViolationsReportRequest): Promise; /** * Stop violation reporting. */ invoke_stopViolationsReport(): Promise; } export interface LogDispatcher { /** * Issued when new message was logged. */ entryAdded(params: Protocol.Log.EntryAddedEvent): void; } export interface MediaApi { /** * Enables the Media domain */ invoke_enable(): Promise; /** * Disables the Media domain. */ invoke_disable(): Promise; } export interface MediaDispatcher { /** * This can be called multiple times, and can be used to set / override / * remove player properties. A null propValue indicates removal. */ playerPropertiesChanged(params: Protocol.Media.PlayerPropertiesChangedEvent): void; /** * Send events as a list, allowing them to be batched on the browser for less * congestion. If batched, events must ALWAYS be in chronological order. */ playerEventsAdded(params: Protocol.Media.PlayerEventsAddedEvent): void; /** * Send a list of any messages that need to be delivered. */ playerMessagesLogged(params: Protocol.Media.PlayerMessagesLoggedEvent): void; /** * Send a list of any errors that need to be delivered. */ playerErrorsRaised(params: Protocol.Media.PlayerErrorsRaisedEvent): void; /** * Called whenever a player is created, or when a new agent joins and receives * a list of active players. If an agent is restored, it will receive one * event for each active player. */ playerCreated(params: Protocol.Media.PlayerCreatedEvent): void; } export interface MemoryApi { /** * Retruns current DOM object counters. */ invoke_getDOMCounters(): Promise; /** * Retruns DOM object counters after preparing renderer for leak detection. */ invoke_getDOMCountersForLeakDetection(): Promise; /** * Prepares for leak detection by terminating workers, stopping spellcheckers, * dropping non-essential internal caches, running garbage collections, etc. */ invoke_prepareForLeakDetection(): Promise; /** * Simulate OomIntervention by purging V8 memory. */ invoke_forciblyPurgeJavaScriptMemory(): Promise; /** * Enable/disable suppressing memory pressure notifications in all processes. */ invoke_setPressureNotificationsSuppressed(params: Protocol.Memory.SetPressureNotificationsSuppressedRequest): Promise; /** * Simulate a memory pressure notification in all processes. */ invoke_simulatePressureNotification(params: Protocol.Memory.SimulatePressureNotificationRequest): Promise; /** * Start collecting native memory profile. */ invoke_startSampling(params: Protocol.Memory.StartSamplingRequest): Promise; /** * Stop collecting native memory profile. */ invoke_stopSampling(): Promise; /** * Retrieve native memory allocations profile * collected since renderer process startup. */ invoke_getAllTimeSamplingProfile(): Promise; /** * Retrieve native memory allocations profile * collected since browser process startup. */ invoke_getBrowserSamplingProfile(): Promise; /** * Retrieve native memory allocations profile collected since last * `startSampling` call. */ invoke_getSamplingProfile(): Promise; } export interface MemoryDispatcher { } export interface NetworkApi { /** * Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted. */ invoke_setAcceptedEncodings(params: Protocol.Network.SetAcceptedEncodingsRequest): Promise; /** * Clears accepted encodings set by setAcceptedEncodings */ invoke_clearAcceptedEncodingsOverride(): Promise; /** * Tells whether clearing browser cache is supported. * @deprecated */ invoke_canClearBrowserCache(): Promise; /** * Tells whether clearing browser cookies is supported. * @deprecated */ invoke_canClearBrowserCookies(): Promise; /** * Tells whether emulation of network conditions is supported. * @deprecated */ invoke_canEmulateNetworkConditions(): Promise; /** * Clears browser cache. */ invoke_clearBrowserCache(): Promise; /** * Clears browser cookies. */ invoke_clearBrowserCookies(): Promise; /** * Response to Network.requestIntercepted which either modifies the request to continue with any * modifications, or blocks it, or completes it with the provided response bytes. If a network * fetch occurs as a result which encounters a redirect an additional Network.requestIntercepted * event will be sent with the same InterceptionId. * Deprecated, use Fetch.continueRequest, Fetch.fulfillRequest and Fetch.failRequest instead. * @deprecated */ invoke_continueInterceptedRequest(params: Protocol.Network.ContinueInterceptedRequestRequest): Promise; /** * Deletes browser cookies with matching name and url or domain/path/partitionKey pair. */ invoke_deleteCookies(params: Protocol.Network.DeleteCookiesRequest): Promise; /** * Disables network tracking, prevents network events from being sent to the client. */ invoke_disable(): Promise; /** * Activates emulation of network conditions. This command is deprecated in favor of the emulateNetworkConditionsByRule * and overrideNetworkState commands, which can be used together to the same effect. * @deprecated */ invoke_emulateNetworkConditions(params: Protocol.Network.EmulateNetworkConditionsRequest): Promise; /** * Activates emulation of network conditions for individual requests using URL match patterns. Unlike the deprecated * Network.emulateNetworkConditions this method does not affect `navigator` state. Use Network.overrideNetworkState to * explicitly modify `navigator` behavior. */ invoke_emulateNetworkConditionsByRule(params: Protocol.Network.EmulateNetworkConditionsByRuleRequest): Promise; /** * Override the state of navigator.onLine and navigator.connection. */ invoke_overrideNetworkState(params: Protocol.Network.OverrideNetworkStateRequest): Promise; /** * Enables network tracking, network events will now be delivered to the client. */ invoke_enable(params: Protocol.Network.EnableRequest): Promise; /** * Configures storing response bodies outside of renderer, so that these survive * a cross-process navigation. * If maxTotalBufferSize is not set, durable messages are disabled. */ invoke_configureDurableMessages(params: Protocol.Network.ConfigureDurableMessagesRequest): Promise; /** * Returns all browser cookies. Depending on the backend support, will return detailed cookie * information in the `cookies` field. * Deprecated. Use Storage.getCookies instead. * @deprecated */ invoke_getAllCookies(): Promise; /** * Returns the DER-encoded certificate. */ invoke_getCertificate(params: Protocol.Network.GetCertificateRequest): Promise; /** * Returns all browser cookies for the current URL. Depending on the backend support, will return * detailed cookie information in the `cookies` field. */ invoke_getCookies(params: Protocol.Network.GetCookiesRequest): Promise; /** * Returns content served for the given request. */ invoke_getResponseBody(params: Protocol.Network.GetResponseBodyRequest): Promise; /** * Returns post data sent with the request. Returns an error when no data was sent with the request. */ invoke_getRequestPostData(params: Protocol.Network.GetRequestPostDataRequest): Promise; /** * Returns content served for the given currently intercepted request. */ invoke_getResponseBodyForInterception(params: Protocol.Network.GetResponseBodyForInterceptionRequest): Promise; /** * Returns a handle to the stream representing the response body. Note that after this command, * the intercepted request can't be continued as is -- you either need to cancel it or to provide * the response body. The stream only supports sequential read, IO.read will fail if the position * is specified. */ invoke_takeResponseBodyForInterceptionAsStream(params: Protocol.Network.TakeResponseBodyForInterceptionAsStreamRequest): Promise; /** * This method sends a new XMLHttpRequest which is identical to the original one. The following * parameters should be identical: method, url, async, request body, extra headers, withCredentials * attribute, user, password. */ invoke_replayXHR(params: Protocol.Network.ReplayXHRRequest): Promise; /** * Searches for given string in response content. */ invoke_searchInResponseBody(params: Protocol.Network.SearchInResponseBodyRequest): Promise; /** * Blocks URLs from loading. */ invoke_setBlockedURLs(params: Protocol.Network.SetBlockedURLsRequest): Promise; /** * Toggles ignoring of service worker for each request. */ invoke_setBypassServiceWorker(params: Protocol.Network.SetBypassServiceWorkerRequest): Promise; /** * Toggles ignoring cache for each request. If `true`, cache will not be used. */ invoke_setCacheDisabled(params: Protocol.Network.SetCacheDisabledRequest): Promise; /** * Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. */ invoke_setCookie(params: Protocol.Network.SetCookieRequest): Promise; /** * Sets given cookies. */ invoke_setCookies(params: Protocol.Network.SetCookiesRequest): Promise; /** * Specifies whether to always send extra HTTP headers with the requests from this page. */ invoke_setExtraHTTPHeaders(params: Protocol.Network.SetExtraHTTPHeadersRequest): Promise; /** * Specifies whether to attach a page script stack id in requests */ invoke_setAttachDebugStack(params: Protocol.Network.SetAttachDebugStackRequest): Promise; /** * Sets the requests to intercept that match the provided patterns and optionally resource types. * Deprecated, please use Fetch.enable instead. * @deprecated */ invoke_setRequestInterception(params: Protocol.Network.SetRequestInterceptionRequest): Promise; /** * Allows overriding user agent with the given string. */ invoke_setUserAgentOverride(params: Protocol.Network.SetUserAgentOverrideRequest): Promise; /** * Enables streaming of the response for the given requestId. * If enabled, the dataReceived event contains the data that was received during streaming. */ invoke_streamResourceContent(params: Protocol.Network.StreamResourceContentRequest): Promise; /** * Returns information about the COEP/COOP isolation status. */ invoke_getSecurityIsolationStatus(params: Protocol.Network.GetSecurityIsolationStatusRequest): Promise; /** * Enables tracking for the Reporting API, events generated by the Reporting API will now be delivered to the client. * Enabling triggers 'reportingApiReportAdded' for all existing reports. */ invoke_enableReportingApi(params: Protocol.Network.EnableReportingApiRequest): Promise; /** * Sets up tracking device bound sessions and fetching of initial set of sessions. */ invoke_enableDeviceBoundSessions(params: Protocol.Network.EnableDeviceBoundSessionsRequest): Promise; /** * Deletes a device bound session. */ invoke_deleteDeviceBoundSession(params: Protocol.Network.DeleteDeviceBoundSessionRequest): Promise; /** * Fetches the schemeful site for a specific origin. */ invoke_fetchSchemefulSite(params: Protocol.Network.FetchSchemefulSiteRequest): Promise; /** * Fetches the resource and returns the content. */ invoke_loadNetworkResource(params: Protocol.Network.LoadNetworkResourceRequest): Promise; /** * Sets Controls for third-party cookie access * Page reload is required before the new cookie behavior will be observed */ invoke_setCookieControls(params: Protocol.Network.SetCookieControlsRequest): Promise; } export interface NetworkDispatcher { /** * Fired when data chunk was received over the network. */ dataReceived(params: Protocol.Network.DataReceivedEvent): void; /** * Fired when EventSource message is received. */ eventSourceMessageReceived(params: Protocol.Network.EventSourceMessageReceivedEvent): void; /** * Fired when HTTP request has failed to load. */ loadingFailed(params: Protocol.Network.LoadingFailedEvent): void; /** * Fired when HTTP request has finished loading. */ loadingFinished(params: Protocol.Network.LoadingFinishedEvent): void; /** * Details of an intercepted HTTP request, which must be either allowed, blocked, modified or * mocked. * Deprecated, use Fetch.requestPaused instead. * @deprecated */ requestIntercepted(params: Protocol.Network.RequestInterceptedEvent): void; /** * Fired if request ended up loading from cache. */ requestServedFromCache(params: Protocol.Network.RequestServedFromCacheEvent): void; /** * Fired when page is about to send HTTP request. */ requestWillBeSent(params: Protocol.Network.RequestWillBeSentEvent): void; /** * Fired when resource loading priority is changed */ resourceChangedPriority(params: Protocol.Network.ResourceChangedPriorityEvent): void; /** * Fired when a signed exchange was received over the network */ signedExchangeReceived(params: Protocol.Network.SignedExchangeReceivedEvent): void; /** * Fired when HTTP response is available. */ responseReceived(params: Protocol.Network.ResponseReceivedEvent): void; /** * Fired when WebSocket is closed. */ webSocketClosed(params: Protocol.Network.WebSocketClosedEvent): void; /** * Fired upon WebSocket creation. */ webSocketCreated(params: Protocol.Network.WebSocketCreatedEvent): void; /** * Fired when WebSocket message error occurs. */ webSocketFrameError(params: Protocol.Network.WebSocketFrameErrorEvent): void; /** * Fired when WebSocket message is received. */ webSocketFrameReceived(params: Protocol.Network.WebSocketFrameReceivedEvent): void; /** * Fired when WebSocket message is sent. */ webSocketFrameSent(params: Protocol.Network.WebSocketFrameSentEvent): void; /** * Fired when WebSocket handshake response becomes available. */ webSocketHandshakeResponseReceived(params: Protocol.Network.WebSocketHandshakeResponseReceivedEvent): void; /** * Fired when WebSocket is about to initiate handshake. */ webSocketWillSendHandshakeRequest(params: Protocol.Network.WebSocketWillSendHandshakeRequestEvent): void; /** * Fired upon WebTransport creation. */ webTransportCreated(params: Protocol.Network.WebTransportCreatedEvent): void; /** * Fired when WebTransport handshake is finished. */ webTransportConnectionEstablished(params: Protocol.Network.WebTransportConnectionEstablishedEvent): void; /** * Fired when WebTransport is disposed. */ webTransportClosed(params: Protocol.Network.WebTransportClosedEvent): void; /** * Fired upon direct_socket.TCPSocket creation. */ directTCPSocketCreated(params: Protocol.Network.DirectTCPSocketCreatedEvent): void; /** * Fired when direct_socket.TCPSocket connection is opened. */ directTCPSocketOpened(params: Protocol.Network.DirectTCPSocketOpenedEvent): void; /** * Fired when direct_socket.TCPSocket is aborted. */ directTCPSocketAborted(params: Protocol.Network.DirectTCPSocketAbortedEvent): void; /** * Fired when direct_socket.TCPSocket is closed. */ directTCPSocketClosed(params: Protocol.Network.DirectTCPSocketClosedEvent): void; /** * Fired when data is sent to tcp direct socket stream. */ directTCPSocketChunkSent(params: Protocol.Network.DirectTCPSocketChunkSentEvent): void; /** * Fired when data is received from tcp direct socket stream. */ directTCPSocketChunkReceived(params: Protocol.Network.DirectTCPSocketChunkReceivedEvent): void; directUDPSocketJoinedMulticastGroup(params: Protocol.Network.DirectUDPSocketJoinedMulticastGroupEvent): void; directUDPSocketLeftMulticastGroup(params: Protocol.Network.DirectUDPSocketLeftMulticastGroupEvent): void; /** * Fired upon direct_socket.UDPSocket creation. */ directUDPSocketCreated(params: Protocol.Network.DirectUDPSocketCreatedEvent): void; /** * Fired when direct_socket.UDPSocket connection is opened. */ directUDPSocketOpened(params: Protocol.Network.DirectUDPSocketOpenedEvent): void; /** * Fired when direct_socket.UDPSocket is aborted. */ directUDPSocketAborted(params: Protocol.Network.DirectUDPSocketAbortedEvent): void; /** * Fired when direct_socket.UDPSocket is closed. */ directUDPSocketClosed(params: Protocol.Network.DirectUDPSocketClosedEvent): void; /** * Fired when message is sent to udp direct socket stream. */ directUDPSocketChunkSent(params: Protocol.Network.DirectUDPSocketChunkSentEvent): void; /** * Fired when message is received from udp direct socket stream. */ directUDPSocketChunkReceived(params: Protocol.Network.DirectUDPSocketChunkReceivedEvent): void; /** * Fired when additional information about a requestWillBeSent event is available from the * network stack. Not every requestWillBeSent event will have an additional * requestWillBeSentExtraInfo fired for it, and there is no guarantee whether requestWillBeSent * or requestWillBeSentExtraInfo will be fired first for the same request. */ requestWillBeSentExtraInfo(params: Protocol.Network.RequestWillBeSentExtraInfoEvent): void; /** * Fired when additional information about a responseReceived event is available from the network * stack. Not every responseReceived event will have an additional responseReceivedExtraInfo for * it, and responseReceivedExtraInfo may be fired before or after responseReceived. */ responseReceivedExtraInfo(params: Protocol.Network.ResponseReceivedExtraInfoEvent): void; /** * Fired when 103 Early Hints headers is received in addition to the common response. * Not every responseReceived event will have an responseReceivedEarlyHints fired. * Only one responseReceivedEarlyHints may be fired for eached responseReceived event. */ responseReceivedEarlyHints(params: Protocol.Network.ResponseReceivedEarlyHintsEvent): void; /** * Fired exactly once for each Trust Token operation. Depending on * the type of the operation and whether the operation succeeded or * failed, the event is fired before the corresponding request was sent * or after the response was received. */ trustTokenOperationDone(params: Protocol.Network.TrustTokenOperationDoneEvent): void; /** * Fired once security policy has been updated. */ policyUpdated(): void; /** * Is sent whenever a new report is added. * And after 'enableReportingApi' for all existing reports. */ reportingApiReportAdded(params: Protocol.Network.ReportingApiReportAddedEvent): void; reportingApiReportUpdated(params: Protocol.Network.ReportingApiReportUpdatedEvent): void; reportingApiEndpointsChangedForOrigin(params: Protocol.Network.ReportingApiEndpointsChangedForOriginEvent): void; /** * Triggered when the initial set of device bound sessions is added. */ deviceBoundSessionsAdded(params: Protocol.Network.DeviceBoundSessionsAddedEvent): void; /** * Triggered when a device bound session event occurs. */ deviceBoundSessionEventOccurred(params: Protocol.Network.DeviceBoundSessionEventOccurredEvent): void; } export interface OverlayApi { /** * Disables domain notifications. */ invoke_disable(): Promise; /** * Enables domain notifications. */ invoke_enable(): Promise; /** * For testing. */ invoke_getHighlightObjectForTest(params: Protocol.Overlay.GetHighlightObjectForTestRequest): Promise; /** * For Persistent Grid testing. */ invoke_getGridHighlightObjectsForTest(params: Protocol.Overlay.GetGridHighlightObjectsForTestRequest): Promise; /** * For Source Order Viewer testing. */ invoke_getSourceOrderHighlightObjectForTest(params: Protocol.Overlay.GetSourceOrderHighlightObjectForTestRequest): Promise; /** * Hides any highlight. */ invoke_hideHighlight(): Promise; /** * Highlights owner element of the frame with given id. * Deprecated: Doesn't work reliably and cannot be fixed due to process * separation (the owner node might be in a different process). Determine * the owner node in the client and use highlightNode. * @deprecated */ invoke_highlightFrame(params: Protocol.Overlay.HighlightFrameRequest): Promise; /** * Highlights DOM node with given id or with the given JavaScript object wrapper. Either nodeId or * objectId must be specified. */ invoke_highlightNode(params: Protocol.Overlay.HighlightNodeRequest): Promise; /** * Highlights given quad. Coordinates are absolute with respect to the main frame viewport. */ invoke_highlightQuad(params: Protocol.Overlay.HighlightQuadRequest): Promise; /** * Highlights given rectangle. Coordinates are absolute with respect to the main frame viewport. * Issue: the method does not handle device pixel ratio (DPR) correctly. * The coordinates currently have to be adjusted by the client * if DPR is not 1 (see crbug.com/437807128). */ invoke_highlightRect(params: Protocol.Overlay.HighlightRectRequest): Promise; /** * Highlights the source order of the children of the DOM node with given id or with the given * JavaScript object wrapper. Either nodeId or objectId must be specified. */ invoke_highlightSourceOrder(params: Protocol.Overlay.HighlightSourceOrderRequest): Promise; /** * Enters the 'inspect' mode. In this mode, elements that user is hovering over are highlighted. * Backend then generates 'inspectNodeRequested' event upon element selection. */ invoke_setInspectMode(params: Protocol.Overlay.SetInspectModeRequest): Promise; /** * Highlights owner element of all frames detected to be ads. */ invoke_setShowAdHighlights(params: Protocol.Overlay.SetShowAdHighlightsRequest): Promise; invoke_setPausedInDebuggerMessage(params: Protocol.Overlay.SetPausedInDebuggerMessageRequest): Promise; /** * Requests that backend shows debug borders on layers */ invoke_setShowDebugBorders(params: Protocol.Overlay.SetShowDebugBordersRequest): Promise; /** * Requests that backend shows the FPS counter */ invoke_setShowFPSCounter(params: Protocol.Overlay.SetShowFPSCounterRequest): Promise; /** * Highlight multiple elements with the CSS Grid overlay. */ invoke_setShowGridOverlays(params: Protocol.Overlay.SetShowGridOverlaysRequest): Promise; invoke_setShowFlexOverlays(params: Protocol.Overlay.SetShowFlexOverlaysRequest): Promise; invoke_setShowScrollSnapOverlays(params: Protocol.Overlay.SetShowScrollSnapOverlaysRequest): Promise; invoke_setShowContainerQueryOverlays(params: Protocol.Overlay.SetShowContainerQueryOverlaysRequest): Promise; invoke_setShowInspectedElementAnchor(params: Protocol.Overlay.SetShowInspectedElementAnchorRequest): Promise; /** * Requests that backend shows paint rectangles */ invoke_setShowPaintRects(params: Protocol.Overlay.SetShowPaintRectsRequest): Promise; /** * Requests that backend shows layout shift regions */ invoke_setShowLayoutShiftRegions(params: Protocol.Overlay.SetShowLayoutShiftRegionsRequest): Promise; /** * Requests that backend shows scroll bottleneck rects */ invoke_setShowScrollBottleneckRects(params: Protocol.Overlay.SetShowScrollBottleneckRectsRequest): Promise; /** * Deprecated, no longer has any effect. * @deprecated */ invoke_setShowHitTestBorders(params: Protocol.Overlay.SetShowHitTestBordersRequest): Promise; /** * Deprecated, no longer has any effect. * @deprecated */ invoke_setShowWebVitals(params: Protocol.Overlay.SetShowWebVitalsRequest): Promise; /** * Paints viewport size upon main frame resize. */ invoke_setShowViewportSizeOnResize(params: Protocol.Overlay.SetShowViewportSizeOnResizeRequest): Promise; /** * Add a dual screen device hinge */ invoke_setShowHinge(params: Protocol.Overlay.SetShowHingeRequest): Promise; /** * Show elements in isolation mode with overlays. */ invoke_setShowIsolatedElements(params: Protocol.Overlay.SetShowIsolatedElementsRequest): Promise; /** * Show Window Controls Overlay for PWA */ invoke_setShowWindowControlsOverlay(params: Protocol.Overlay.SetShowWindowControlsOverlayRequest): Promise; } export interface OverlayDispatcher { /** * Fired when the node should be inspected. This happens after call to `setInspectMode` or when * user manually inspects an element. */ inspectNodeRequested(params: Protocol.Overlay.InspectNodeRequestedEvent): void; /** * Fired when the node should be highlighted. This happens after call to `setInspectMode`. */ nodeHighlightRequested(params: Protocol.Overlay.NodeHighlightRequestedEvent): void; /** * Fired when user asks to capture screenshot of some area on the page. */ screenshotRequested(params: Protocol.Overlay.ScreenshotRequestedEvent): void; /** * Fired when user asks to show the Inspect panel. */ inspectPanelShowRequested(params: Protocol.Overlay.InspectPanelShowRequestedEvent): void; /** * Fired when user asks to restore the Inspected Element floating window. */ inspectedElementWindowRestored(params: Protocol.Overlay.InspectedElementWindowRestoredEvent): void; /** * Fired when user cancels the inspect mode. */ inspectModeCanceled(): void; } export interface PWAApi { /** * Returns the following OS state for the given manifest id. */ invoke_getOsAppState(params: Protocol.PWA.GetOsAppStateRequest): Promise; /** * 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. */ invoke_install(params: Protocol.PWA.InstallRequest): Promise