chrome-devtools-frontend
Version:
Chrome DevTools UI
1,168 lines (1,165 loc) • 131 kB
TypeScript
// Copyright (c) 2020 The Chromium Authors. All rights reserved.
// 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.
*/
/**
* Mappings from protocol event and command names to the types required for them.
*/
export namespace ProtocolMapping {
export interface Events {
/**
* Event for when an animation has been cancelled.
*/
'Animation.animationCanceled': [Protocol.Animation.AnimationCanceledEvent];
/**
* Event for each animation that has been created.
*/
'Animation.animationCreated': [Protocol.Animation.AnimationCreatedEvent];
/**
* Event for animation that has been started.
*/
'Animation.animationStarted': [Protocol.Animation.AnimationStartedEvent];
'ApplicationCache.applicationCacheStatusUpdated': [Protocol.ApplicationCache.ApplicationCacheStatusUpdatedEvent];
'ApplicationCache.networkStateUpdated': [Protocol.ApplicationCache.NetworkStateUpdatedEvent];
'Audits.issueAdded': [Protocol.Audits.IssueAddedEvent];
/**
* Called when the recording state for the service has been updated.
*/
'BackgroundService.recordingStateChanged': [Protocol.BackgroundService.RecordingStateChangedEvent];
/**
* Called with all existing backgroundServiceEvents when enabled, and all new
* events afterwards if enabled and recording.
*/
'BackgroundService.backgroundServiceEventReceived':
[Protocol.BackgroundService.BackgroundServiceEventReceivedEvent];
/**
* Fires whenever a web font is updated. A non-empty font parameter indicates a successfully loaded
* web font
*/
'CSS.fontsUpdated': [Protocol.CSS.FontsUpdatedEvent];
/**
* Fires whenever a MediaQuery result changes (for example, after a browser window has been
* resized.) The current implementation considers only viewport-dependent media features.
*/
'CSS.mediaQueryResultChanged': [];
/**
* Fired whenever an active document stylesheet is added.
*/
'CSS.styleSheetAdded': [Protocol.CSS.StyleSheetAddedEvent];
/**
* Fired whenever a stylesheet is changed as a result of the client operation.
*/
'CSS.styleSheetChanged': [Protocol.CSS.StyleSheetChangedEvent];
/**
* Fired whenever an active document stylesheet is removed.
*/
'CSS.styleSheetRemoved': [Protocol.CSS.StyleSheetRemovedEvent];
/**
* This is fired whenever the list of available sinks changes. A sink is a
* device or a software surface that you can cast to.
*/
'Cast.sinksUpdated': [Protocol.Cast.SinksUpdatedEvent];
/**
* This is fired whenever the outstanding issue/error message changes.
* |issueMessage| is empty if there is no issue.
*/
'Cast.issueUpdated': [Protocol.Cast.IssueUpdatedEvent];
/**
* Fired when `Element`'s attribute is modified.
*/
'DOM.attributeModified': [Protocol.DOM.AttributeModifiedEvent];
/**
* Fired when `Element`'s attribute is removed.
*/
'DOM.attributeRemoved': [Protocol.DOM.AttributeRemovedEvent];
/**
* Mirrors `DOMCharacterDataModified` event.
*/
'DOM.characterDataModified': [Protocol.DOM.CharacterDataModifiedEvent];
/**
* Fired when `Container`'s child node count has changed.
*/
'DOM.childNodeCountUpdated': [Protocol.DOM.ChildNodeCountUpdatedEvent];
/**
* Mirrors `DOMNodeInserted` event.
*/
'DOM.childNodeInserted': [Protocol.DOM.ChildNodeInsertedEvent];
/**
* Mirrors `DOMNodeRemoved` event.
*/
'DOM.childNodeRemoved': [Protocol.DOM.ChildNodeRemovedEvent];
/**
* Called when distrubution is changed.
*/
'DOM.distributedNodesUpdated': [Protocol.DOM.DistributedNodesUpdatedEvent];
/**
* Fired when `Document` has been totally updated. Node ids are no longer valid.
*/
'DOM.documentUpdated': [];
/**
* Fired when `Element`'s inline style is modified via a CSS property modification.
*/
'DOM.inlineStyleInvalidated': [Protocol.DOM.InlineStyleInvalidatedEvent];
/**
* Called when a pseudo element is added to an element.
*/
'DOM.pseudoElementAdded': [Protocol.DOM.PseudoElementAddedEvent];
/**
* Called when a pseudo element is removed from an element.
*/
'DOM.pseudoElementRemoved': [Protocol.DOM.PseudoElementRemovedEvent];
/**
* Fired when backend wants to provide client with the missing DOM structure. This happens upon
* most of the calls requesting node ids.
*/
'DOM.setChildNodes': [Protocol.DOM.SetChildNodesEvent];
/**
* Called when shadow root is popped from the element.
*/
'DOM.shadowRootPopped': [Protocol.DOM.ShadowRootPoppedEvent];
/**
* Called when shadow root is pushed into the element.
*/
'DOM.shadowRootPushed': [Protocol.DOM.ShadowRootPushedEvent];
'DOMStorage.domStorageItemAdded': [Protocol.DOMStorage.DomStorageItemAddedEvent];
'DOMStorage.domStorageItemRemoved': [Protocol.DOMStorage.DomStorageItemRemovedEvent];
'DOMStorage.domStorageItemUpdated': [Protocol.DOMStorage.DomStorageItemUpdatedEvent];
'DOMStorage.domStorageItemsCleared': [Protocol.DOMStorage.DomStorageItemsClearedEvent];
'Database.addDatabase': [Protocol.Database.AddDatabaseEvent];
/**
* Notification sent after the virtual time budget for the current VirtualTimePolicy has run out.
*/
'Emulation.virtualTimeBudgetExpired': [];
/**
* Issued when the target starts or stops needing BeginFrames.
* Deprecated. Issue beginFrame unconditionally instead and use result from
* beginFrame to detect whether the frames were suppressed.
*/
'HeadlessExperimental.needsBeginFramesChanged': [Protocol.HeadlessExperimental.NeedsBeginFramesChangedEvent];
/**
* Fired when remote debugging connection is about to be terminated. Contains detach reason.
*/
'Inspector.detached': [Protocol.Inspector.DetachedEvent];
/**
* Fired when debugging target has crashed
*/
'Inspector.targetCrashed': [];
/**
* Fired when debugging target has reloaded after crash
*/
'Inspector.targetReloadedAfterCrash': [];
'LayerTree.layerPainted': [Protocol.LayerTree.LayerPaintedEvent];
'LayerTree.layerTreeDidChange': [Protocol.LayerTree.LayerTreeDidChangeEvent];
/**
* Issued when new message was logged.
*/
'Log.entryAdded': [Protocol.Log.EntryAddedEvent];
/**
* Fired when data chunk was received over the network.
*/
'Network.dataReceived': [Protocol.Network.DataReceivedEvent];
/**
* Fired when EventSource message is received.
*/
'Network.eventSourceMessageReceived': [Protocol.Network.EventSourceMessageReceivedEvent];
/**
* Fired when HTTP request has failed to load.
*/
'Network.loadingFailed': [Protocol.Network.LoadingFailedEvent];
/**
* Fired when HTTP request has finished loading.
*/
'Network.loadingFinished': [Protocol.Network.LoadingFinishedEvent];
/**
* Details of an intercepted HTTP request, which must be either allowed, blocked, modified or
* mocked.
* Deprecated, use Fetch.requestPaused instead.
*/
'Network.requestIntercepted': [Protocol.Network.RequestInterceptedEvent];
/**
* Fired if request ended up loading from cache.
*/
'Network.requestServedFromCache': [Protocol.Network.RequestServedFromCacheEvent];
/**
* Fired when page is about to send HTTP request.
*/
'Network.requestWillBeSent': [Protocol.Network.RequestWillBeSentEvent];
/**
* Fired when resource loading priority is changed
*/
'Network.resourceChangedPriority': [Protocol.Network.ResourceChangedPriorityEvent];
/**
* Fired when a signed exchange was received over the network
*/
'Network.signedExchangeReceived': [Protocol.Network.SignedExchangeReceivedEvent];
/**
* Fired when HTTP response is available.
*/
'Network.responseReceived': [Protocol.Network.ResponseReceivedEvent];
/**
* Fired when WebSocket is closed.
*/
'Network.webSocketClosed': [Protocol.Network.WebSocketClosedEvent];
/**
* Fired upon WebSocket creation.
*/
'Network.webSocketCreated': [Protocol.Network.WebSocketCreatedEvent];
/**
* Fired when WebSocket message error occurs.
*/
'Network.webSocketFrameError': [Protocol.Network.WebSocketFrameErrorEvent];
/**
* Fired when WebSocket message is received.
*/
'Network.webSocketFrameReceived': [Protocol.Network.WebSocketFrameReceivedEvent];
/**
* Fired when WebSocket message is sent.
*/
'Network.webSocketFrameSent': [Protocol.Network.WebSocketFrameSentEvent];
/**
* Fired when WebSocket handshake response becomes available.
*/
'Network.webSocketHandshakeResponseReceived': [Protocol.Network.WebSocketHandshakeResponseReceivedEvent];
/**
* Fired when WebSocket is about to initiate handshake.
*/
'Network.webSocketWillSendHandshakeRequest': [Protocol.Network.WebSocketWillSendHandshakeRequestEvent];
/**
* Fired upon WebTransport creation.
*/
'Network.webTransportCreated': [Protocol.Network.WebTransportCreatedEvent];
/**
* Fired when WebTransport handshake is finished.
*/
'Network.webTransportConnectionEstablished': [Protocol.Network.WebTransportConnectionEstablishedEvent];
/**
* Fired when WebTransport is disposed.
*/
'Network.webTransportClosed': [Protocol.Network.WebTransportClosedEvent];
/**
* 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.
*/
'Network.requestWillBeSentExtraInfo': [Protocol.Network.RequestWillBeSentExtraInfoEvent];
/**
* 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.
*/
'Network.responseReceivedExtraInfo': [Protocol.Network.ResponseReceivedExtraInfoEvent];
/**
* 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.
*/
'Network.trustTokenOperationDone': [Protocol.Network.TrustTokenOperationDoneEvent];
/**
* Fired when the node should be inspected. This happens after call to `setInspectMode` or when
* user manually inspects an element.
*/
'Overlay.inspectNodeRequested': [Protocol.Overlay.InspectNodeRequestedEvent];
/**
* Fired when the node should be highlighted. This happens after call to `setInspectMode`.
*/
'Overlay.nodeHighlightRequested': [Protocol.Overlay.NodeHighlightRequestedEvent];
/**
* Fired when user asks to capture screenshot of some area on the page.
*/
'Overlay.screenshotRequested': [Protocol.Overlay.ScreenshotRequestedEvent];
/**
* Fired when user cancels the inspect mode.
*/
'Overlay.inspectModeCanceled': [];
'Page.domContentEventFired': [Protocol.Page.DomContentEventFiredEvent];
/**
* Emitted only when `page.interceptFileChooser` is enabled.
*/
'Page.fileChooserOpened': [Protocol.Page.FileChooserOpenedEvent];
/**
* Fired when frame has been attached to its parent.
*/
'Page.frameAttached': [Protocol.Page.FrameAttachedEvent];
/**
* Fired when frame no longer has a scheduled navigation.
*/
'Page.frameClearedScheduledNavigation': [Protocol.Page.FrameClearedScheduledNavigationEvent];
/**
* Fired when frame has been detached from its parent.
*/
'Page.frameDetached': [Protocol.Page.FrameDetachedEvent];
/**
* Fired once navigation of the frame has completed. Frame is now associated with the new loader.
*/
'Page.frameNavigated': [Protocol.Page.FrameNavigatedEvent];
/**
* Fired when opening document to write to.
*/
'Page.documentOpened': [Protocol.Page.DocumentOpenedEvent];
'Page.frameResized': [];
/**
* Fired when a renderer-initiated navigation is requested.
* Navigation may still be cancelled after the event is issued.
*/
'Page.frameRequestedNavigation': [Protocol.Page.FrameRequestedNavigationEvent];
/**
* Fired when frame schedules a potential navigation.
*/
'Page.frameScheduledNavigation': [Protocol.Page.FrameScheduledNavigationEvent];
/**
* Fired when frame has started loading.
*/
'Page.frameStartedLoading': [Protocol.Page.FrameStartedLoadingEvent];
/**
* Fired when frame has stopped loading.
*/
'Page.frameStoppedLoading': [Protocol.Page.FrameStoppedLoadingEvent];
/**
* Fired when page is about to start a download.
*/
'Page.downloadWillBegin': [Protocol.Page.DownloadWillBeginEvent];
/**
* Fired when download makes progress. Last call has |done| == true.
*/
'Page.downloadProgress': [Protocol.Page.DownloadProgressEvent];
/**
* Fired when interstitial page was hidden
*/
'Page.interstitialHidden': [];
/**
* Fired when interstitial page was shown
*/
'Page.interstitialShown': [];
/**
* Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) has been
* closed.
*/
'Page.javascriptDialogClosed': [Protocol.Page.JavascriptDialogClosedEvent];
/**
* Fired when a JavaScript initiated dialog (alert, confirm, prompt, or onbeforeunload) is about to
* open.
*/
'Page.javascriptDialogOpening': [Protocol.Page.JavascriptDialogOpeningEvent];
/**
* Fired for top level page lifecycle events such as navigation, load, paint, etc.
*/
'Page.lifecycleEvent': [Protocol.Page.LifecycleEventEvent];
'Page.loadEventFired': [Protocol.Page.LoadEventFiredEvent];
/**
* Fired when same-document navigation happens, e.g. due to history API usage or anchor navigation.
*/
'Page.navigatedWithinDocument': [Protocol.Page.NavigatedWithinDocumentEvent];
/**
* Compressed image data requested by the `startScreencast`.
*/
'Page.screencastFrame': [Protocol.Page.ScreencastFrameEvent];
/**
* Fired when the page with currently enabled screencast was shown or hidden `.
*/
'Page.screencastVisibilityChanged': [Protocol.Page.ScreencastVisibilityChangedEvent];
/**
* Fired when a new window is going to be opened, via window.open(), link click, form submission,
* etc.
*/
'Page.windowOpen': [Protocol.Page.WindowOpenEvent];
/**
* Issued for every compilation cache generated. Is only available
* if Page.setGenerateCompilationCache is enabled.
*/
'Page.compilationCacheProduced': [Protocol.Page.CompilationCacheProducedEvent];
/**
* Current values of the metrics.
*/
'Performance.metrics': [Protocol.Performance.MetricsEvent];
/**
* Sent when a performance timeline event is added. See reportPerformanceTimeline method.
*/
'PerformanceTimeline.timelineEventAdded': [Protocol.PerformanceTimeline.TimelineEventAddedEvent];
/**
* There is a certificate error. If overriding certificate errors is enabled, then it should be
* handled with the `handleCertificateError` command. Note: this event does not fire if the
* certificate error has been allowed internally. Only one client per target should override
* certificate errors at the same time.
*/
'Security.certificateError': [Protocol.Security.CertificateErrorEvent];
/**
* The security state of the page changed.
*/
'Security.visibleSecurityStateChanged': [Protocol.Security.VisibleSecurityStateChangedEvent];
/**
* The security state of the page changed.
*/
'Security.securityStateChanged': [Protocol.Security.SecurityStateChangedEvent];
'ServiceWorker.workerErrorReported': [Protocol.ServiceWorker.WorkerErrorReportedEvent];
'ServiceWorker.workerRegistrationUpdated': [Protocol.ServiceWorker.WorkerRegistrationUpdatedEvent];
'ServiceWorker.workerVersionUpdated': [Protocol.ServiceWorker.WorkerVersionUpdatedEvent];
/**
* A cache's contents have been modified.
*/
'Storage.cacheStorageContentUpdated': [Protocol.Storage.CacheStorageContentUpdatedEvent];
/**
* A cache has been added/deleted.
*/
'Storage.cacheStorageListUpdated': [Protocol.Storage.CacheStorageListUpdatedEvent];
/**
* The origin's IndexedDB object store has been modified.
*/
'Storage.indexedDBContentUpdated': [Protocol.Storage.IndexedDBContentUpdatedEvent];
/**
* The origin's IndexedDB database list has been modified.
*/
'Storage.indexedDBListUpdated': [Protocol.Storage.IndexedDBListUpdatedEvent];
/**
* Issued when attached to target because of auto-attach or `attachToTarget` command.
*/
'Target.attachedToTarget': [Protocol.Target.AttachedToTargetEvent];
/**
* Issued when detached from target for any reason (including `detachFromTarget` command). Can be
* issued multiple times per target if multiple sessions have been attached to it.
*/
'Target.detachedFromTarget': [Protocol.Target.DetachedFromTargetEvent];
/**
* Notifies about a new protocol message received from the session (as reported in
* `attachedToTarget` event).
*/
'Target.receivedMessageFromTarget': [Protocol.Target.ReceivedMessageFromTargetEvent];
/**
* Issued when a possible inspection target is created.
*/
'Target.targetCreated': [Protocol.Target.TargetCreatedEvent];
/**
* Issued when a target is destroyed.
*/
'Target.targetDestroyed': [Protocol.Target.TargetDestroyedEvent];
/**
* Issued when a target has crashed.
*/
'Target.targetCrashed': [Protocol.Target.TargetCrashedEvent];
/**
* Issued when some information about a target has changed. This only happens between
* `targetCreated` and `targetDestroyed`.
*/
'Target.targetInfoChanged': [Protocol.Target.TargetInfoChangedEvent];
/**
* Informs that port was successfully bound and got a specified connection id.
*/
'Tethering.accepted': [Protocol.Tethering.AcceptedEvent];
'Tracing.bufferUsage': [Protocol.Tracing.BufferUsageEvent];
/**
* Contains an bucket of collected trace events. When tracing is stopped collected events will be
* send as a sequence of dataCollected events followed by tracingComplete event.
*/
'Tracing.dataCollected': [Protocol.Tracing.DataCollectedEvent];
/**
* Signals that tracing is stopped and there is no trace buffers pending flush, all data were
* delivered via dataCollected events.
*/
'Tracing.tracingComplete': [Protocol.Tracing.TracingCompleteEvent];
/**
* 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.
*/
'Fetch.requestPaused': [Protocol.Fetch.RequestPausedEvent];
/**
* Issued when the domain is enabled with handleAuthRequests set to true.
* The request is paused until client responds with continueWithAuth.
*/
'Fetch.authRequired': [Protocol.Fetch.AuthRequiredEvent];
/**
* Notifies that a new BaseAudioContext has been created.
*/
'WebAudio.contextCreated': [Protocol.WebAudio.ContextCreatedEvent];
/**
* Notifies that an existing BaseAudioContext will be destroyed.
*/
'WebAudio.contextWillBeDestroyed': [Protocol.WebAudio.ContextWillBeDestroyedEvent];
/**
* Notifies that existing BaseAudioContext has changed some properties (id stays the same)..
*/
'WebAudio.contextChanged': [Protocol.WebAudio.ContextChangedEvent];
/**
* Notifies that the construction of an AudioListener has finished.
*/
'WebAudio.audioListenerCreated': [Protocol.WebAudio.AudioListenerCreatedEvent];
/**
* Notifies that a new AudioListener has been created.
*/
'WebAudio.audioListenerWillBeDestroyed': [Protocol.WebAudio.AudioListenerWillBeDestroyedEvent];
/**
* Notifies that a new AudioNode has been created.
*/
'WebAudio.audioNodeCreated': [Protocol.WebAudio.AudioNodeCreatedEvent];
/**
* Notifies that an existing AudioNode has been destroyed.
*/
'WebAudio.audioNodeWillBeDestroyed': [Protocol.WebAudio.AudioNodeWillBeDestroyedEvent];
/**
* Notifies that a new AudioParam has been created.
*/
'WebAudio.audioParamCreated': [Protocol.WebAudio.AudioParamCreatedEvent];
/**
* Notifies that an existing AudioParam has been destroyed.
*/
'WebAudio.audioParamWillBeDestroyed': [Protocol.WebAudio.AudioParamWillBeDestroyedEvent];
/**
* Notifies that two AudioNodes are connected.
*/
'WebAudio.nodesConnected': [Protocol.WebAudio.NodesConnectedEvent];
/**
* Notifies that AudioNodes are disconnected. The destination can be null, and it means all the outgoing connections from the source are disconnected.
*/
'WebAudio.nodesDisconnected': [Protocol.WebAudio.NodesDisconnectedEvent];
/**
* Notifies that an AudioNode is connected to an AudioParam.
*/
'WebAudio.nodeParamConnected': [Protocol.WebAudio.NodeParamConnectedEvent];
/**
* Notifies that an AudioNode is disconnected to an AudioParam.
*/
'WebAudio.nodeParamDisconnected': [Protocol.WebAudio.NodeParamDisconnectedEvent];
/**
* This can be called multiple times, and can be used to set / override /
* remove player properties. A null propValue indicates removal.
*/
'Media.playerPropertiesChanged': [Protocol.Media.PlayerPropertiesChangedEvent];
/**
* 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.
*/
'Media.playerEventsAdded': [Protocol.Media.PlayerEventsAddedEvent];
/**
* Send a list of any messages that need to be delivered.
*/
'Media.playerMessagesLogged': [Protocol.Media.PlayerMessagesLoggedEvent];
/**
* Send a list of any errors that need to be delivered.
*/
'Media.playerErrorsRaised': [Protocol.Media.PlayerErrorsRaisedEvent];
/**
* Called whenever a player is created, or when a new agent joins and recieves
* a list of active players. If an agent is restored, it will recieve the full
* list of player ids and all events again.
*/
'Media.playersCreated': [Protocol.Media.PlayersCreatedEvent];
/**
* Fired when breakpoint is resolved to an actual script and location.
*/
'Debugger.breakpointResolved': [Protocol.Debugger.BreakpointResolvedEvent];
/**
* Fired when the virtual machine stopped on breakpoint or exception or any other stop criteria.
*/
'Debugger.paused': [Protocol.Debugger.PausedEvent];
/**
* Fired when the virtual machine resumed execution.
*/
'Debugger.resumed': [];
/**
* Fired when virtual machine fails to parse the script.
*/
'Debugger.scriptFailedToParse': [Protocol.Debugger.ScriptFailedToParseEvent];
/**
* Fired when virtual machine parses script. This event is also fired for all known and uncollected
* scripts upon enabling debugger.
*/
'Debugger.scriptParsed': [Protocol.Debugger.ScriptParsedEvent];
'HeapProfiler.addHeapSnapshotChunk': [Protocol.HeapProfiler.AddHeapSnapshotChunkEvent];
/**
* If heap objects tracking has been started then backend may send update for one or more fragments
*/
'HeapProfiler.heapStatsUpdate': [Protocol.HeapProfiler.HeapStatsUpdateEvent];
/**
* If heap objects tracking has been started then backend regularly sends a current value for last
* seen object id and corresponding timestamp. If the were changes in the heap since last event
* then one or more heapStatsUpdate events will be sent before a new lastSeenObjectId event.
*/
'HeapProfiler.lastSeenObjectId': [Protocol.HeapProfiler.LastSeenObjectIdEvent];
'HeapProfiler.reportHeapSnapshotProgress': [Protocol.HeapProfiler.ReportHeapSnapshotProgressEvent];
'HeapProfiler.resetProfiles': [];
'Profiler.consoleProfileFinished': [Protocol.Profiler.ConsoleProfileFinishedEvent];
/**
* Sent when new profile recording is started using console.profile() call.
*/
'Profiler.consoleProfileStarted': [Protocol.Profiler.ConsoleProfileStartedEvent];
/**
* Reports coverage delta since the last poll (either from an event like this, or from
* `takePreciseCoverage` for the current isolate. May only be sent if precise code
* coverage has been started. This event can be trigged by the embedder to, for example,
* trigger collection of coverage data immediatelly at a certain point in time.
*/
'Profiler.preciseCoverageDeltaUpdate': [Protocol.Profiler.PreciseCoverageDeltaUpdateEvent];
/**
* Notification is issued every time when binding is called.
*/
'Runtime.bindingCalled': [Protocol.Runtime.BindingCalledEvent];
/**
* Issued when console API was called.
*/
'Runtime.consoleAPICalled': [Protocol.Runtime.ConsoleAPICalledEvent];
/**
* Issued when unhandled exception was revoked.
*/
'Runtime.exceptionRevoked': [Protocol.Runtime.ExceptionRevokedEvent];
/**
* Issued when exception was thrown and unhandled.
*/
'Runtime.exceptionThrown': [Protocol.Runtime.ExceptionThrownEvent];
/**
* Issued when new execution context is created.
*/
'Runtime.executionContextCreated': [Protocol.Runtime.ExecutionContextCreatedEvent];
/**
* Issued when execution context is destroyed.
*/
'Runtime.executionContextDestroyed': [Protocol.Runtime.ExecutionContextDestroyedEvent];
/**
* Issued when all executionContexts were cleared in browser
*/
'Runtime.executionContextsCleared': [];
/**
* Issued when object should be inspected (for example, as a result of inspect() command line API
* call).
*/
'Runtime.inspectRequested': [Protocol.Runtime.InspectRequestedEvent];
}
export interface Commands {
/**
* Disables the accessibility domain.
*/
'Accessibility.disable': {paramsType: []; returnType: void;};
/**
* 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.
*/
'Accessibility.enable': {paramsType: []; returnType: void;};
/**
* Fetches the accessibility node and partial accessibility tree for this DOM node, if it exists.
*/
'Accessibility.getPartialAXTree': {
paramsType: [Protocol.Accessibility.GetPartialAXTreeRequest?];
returnType: Protocol.Accessibility.GetPartialAXTreeResponse;
};
/**
* Fetches the entire accessibility tree for the root Document
*/
'Accessibility.getFullAXTree': {
paramsType: [Protocol.Accessibility.GetFullAXTreeRequest?];
returnType: Protocol.Accessibility.GetFullAXTreeResponse;
};
/**
* Fetches a particular accessibility node by AXNodeId.
* Requires `enable()` to have been called previously.
*/
'Accessibility.getChildAXNodes': {
paramsType: [Protocol.Accessibility.GetChildAXNodesRequest];
returnType: Protocol.Accessibility.GetChildAXNodesResponse;
};
/**
* 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 mactch 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.
*/
'Accessibility.queryAXTree': {
paramsType: [Protocol.Accessibility.QueryAXTreeRequest?]; returnType: Protocol.Accessibility.QueryAXTreeResponse;
};
/**
* Disables animation domain notifications.
*/
'Animation.disable': {paramsType: []; returnType: void;};
/**
* Enables animation domain notifications.
*/
'Animation.enable': {paramsType: []; returnType: void;};
/**
* Returns the current time of the an animation.
*/
'Animation.getCurrentTime': {
paramsType: [Protocol.Animation.GetCurrentTimeRequest]; returnType: Protocol.Animation.GetCurrentTimeResponse;
};
/**
* Gets the playback rate of the document timeline.
*/
'Animation.getPlaybackRate': {paramsType: []; returnType: Protocol.Animation.GetPlaybackRateResponse;};
/**
* Releases a set of animations to no longer be manipulated.
*/
'Animation.releaseAnimations': {paramsType: [Protocol.Animation.ReleaseAnimationsRequest]; returnType: void;};
/**
* Gets the remote object of the Animation.
*/
'Animation.resolveAnimation': {
paramsType: [Protocol.Animation.ResolveAnimationRequest]; returnType: Protocol.Animation.ResolveAnimationResponse;
};
/**
* Seek a set of animations to a particular time within each animation.
*/
'Animation.seekAnimations': {paramsType: [Protocol.Animation.SeekAnimationsRequest]; returnType: void;};
/**
* Sets the paused state of a set of animations.
*/
'Animation.setPaused': {paramsType: [Protocol.Animation.SetPausedRequest]; returnType: void;};
/**
* Sets the playback rate of the document timeline.
*/
'Animation.setPlaybackRate': {paramsType: [Protocol.Animation.SetPlaybackRateRequest]; returnType: void;};
/**
* Sets the timing of an animation node.
*/
'Animation.setTiming': {paramsType: [Protocol.Animation.SetTimingRequest]; returnType: void;};
/**
* Enables application cache domain notifications.
*/
'ApplicationCache.enable': {paramsType: []; returnType: void;};
/**
* Returns relevant application cache data for the document in given frame.
*/
'ApplicationCache.getApplicationCacheForFrame': {
paramsType: [Protocol.ApplicationCache.GetApplicationCacheForFrameRequest];
returnType: Protocol.ApplicationCache.GetApplicationCacheForFrameResponse;
};
/**
* Returns array of frame identifiers with manifest urls for each frame containing a document
* associated with some application cache.
*/
'ApplicationCache.getFramesWithManifests':
{paramsType: []; returnType: Protocol.ApplicationCache.GetFramesWithManifestsResponse;};
/**
* Returns manifest URL for document in the given frame.
*/
'ApplicationCache.getManifestForFrame': {
paramsType: [Protocol.ApplicationCache.GetManifestForFrameRequest];
returnType: Protocol.ApplicationCache.GetManifestForFrameResponse;
};
/**
* Returns the response body and size if it were re-encoded with the specified settings. Only
* applies to images.
*/
'Audits.getEncodedResponse': {
paramsType: [Protocol.Audits.GetEncodedResponseRequest]; returnType: Protocol.Audits.GetEncodedResponseResponse;
};
/**
* Disables issues domain, prevents further issues from being reported to the client.
*/
'Audits.disable': {paramsType: []; returnType: void;};
/**
* Enables issues domain, sends the issues collected so far to the client by means of the
* `issueAdded` event.
*/
'Audits.enable': {paramsType: []; returnType: void;};
/**
* Runs the contrast check for the target page. Found issues are reported
* using Audits.issueAdded event.
*/
'Audits.checkContrast': {paramsType: []; returnType: void;};
/**
* Enables event updates for the service.
*/
'BackgroundService.startObserving':
{paramsType: [Protocol.BackgroundService.StartObservingRequest]; returnType: void;};
/**
* Disables event updates for the service.
*/
'BackgroundService.stopObserving':
{paramsType: [Protocol.BackgroundService.StopObservingRequest]; returnType: void;};
/**
* Set the recording state for the service.
*/
'BackgroundService.setRecording': {paramsType: [Protocol.BackgroundService.SetRecordingRequest]; returnType: void;};
/**
* Clears all stored data for the service.
*/
'BackgroundService.clearEvents': {paramsType: [Protocol.BackgroundService.ClearEventsRequest]; returnType: void;};
/**
* Set permission settings for given origin.
*/
'Browser.setPermission': {paramsType: [Protocol.Browser.SetPermissionRequest]; returnType: void;};
/**
* Grant specific permissions to the given origin and reject all others.
*/
'Browser.grantPermissions': {paramsType: [Protocol.Browser.GrantPermissionsRequest]; returnType: void;};
/**
* Reset all permission management for all origins.
*/
'Browser.resetPermissions': {paramsType: [Protocol.Browser.ResetPermissionsRequest?]; returnType: void;};
/**
* Set the behavior when downloading a file.
*/
'Browser.setDownloadBehavior': {paramsType: [Protocol.Browser.SetDownloadBehaviorRequest]; returnType: void;};
/**
* Close browser gracefully.
*/
'Browser.close': {paramsType: []; returnType: void;};
/**
* Crashes browser on the main thread.
*/
'Browser.crash': {paramsType: []; returnType: void;};
/**
* Crashes GPU process.
*/
'Browser.crashGpuProcess': {paramsType: []; returnType: void;};
/**
* Returns version information.
*/
'Browser.getVersion': {paramsType: []; returnType: Protocol.Browser.GetVersionResponse;};
/**
* Returns the command line switches for the browser process if, and only if
* --enable-automation is on the commandline.
*/
'Browser.getBrowserCommandLine': {paramsType: []; returnType: Protocol.Browser.GetBrowserCommandLineResponse;};
/**
* Get Chrome histograms.
*/
'Browser.getHistograms':
{paramsType: [Protocol.Browser.GetHistogramsRequest?]; returnType: Protocol.Browser.GetHistogramsResponse;};
/**
* Get a Chrome histogram by name.
*/
'Browser.getHistogram':
{paramsType: [Protocol.Browser.GetHistogramRequest]; returnType: Protocol.Browser.GetHistogramResponse;};
/**
* Get position and size of the browser window.
*/
'Browser.getWindowBounds':
{paramsType: [Protocol.Browser.GetWindowBoundsRequest]; returnType: Protocol.Browser.GetWindowBoundsResponse;};
/**
* Get the browser window that contains the devtools target.
*/
'Browser.getWindowForTarget': {
paramsType: [Protocol.Browser.GetWindowForTargetRequest?];
returnType: Protocol.Browser.GetWindowForTargetResponse;
};
/**
* Set position and/or size of the browser window.
*/
'Browser.setWindowBounds': {paramsType: [Protocol.Browser.SetWindowBoundsRequest]; returnType: void;};
/**
* Set dock tile details, platform-specific.
*/
'Browser.setDockTile': {paramsType: [Protocol.Browser.SetDockTileRequest?]; returnType: void;};
/**
* Invoke custom browser commands used by telemetry.
*/
'Browser.executeBrowserCommand': {paramsType: [Protocol.Browser.ExecuteBrowserCommandRequest]; returnType: void;};
/**
* Inserts a new rule with the given `ruleText` in a stylesheet with given `styleSheetId`, at the
* position specified by `location`.
*/
'CSS.addRule': {paramsType: [Protocol.CSS.AddRuleRequest]; returnType: Protocol.CSS.AddRuleResponse;};
/**
* Returns all class names from specified stylesheet.
*/
'CSS.collectClassNames':
{paramsType: [Protocol.CSS.CollectClassNamesRequest]; returnType: Protocol.CSS.CollectClassNamesResponse;};
/**
* Creates a new special "via-inspector" stylesheet in the frame with given `frameId`.
*/
'CSS.createStyleSheet':
{paramsType: [Protocol.CSS.CreateStyleSheetRequest]; returnType: Protocol.CSS.CreateStyleSheetResponse;};
/**
* Disables the CSS agent for the given page.
*/
'CSS.disable': {paramsType: []; returnType: void;};
/**
* 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.
*/
'CSS.enable': {paramsType: []; returnType: void;};
/**
* Ensures that the given node will have specified pseudo-classes whenever its style is computed by
* the browser.
*/
'CSS.forcePseudoState': {paramsType: [Protocol.CSS.ForcePseudoStateRequest]; returnType: void;};
'CSS.getBackgroundColors':
{paramsType: [Protocol.CSS.GetBackgroundColorsRequest]; returnType: Protocol.CSS.GetBackgroundColorsResponse;};
/**
* Returns the computed style for a DOM node identified by `nodeId`.
*/
'CSS.getComputedStyleForNode': {
paramsType: [Protocol.CSS.GetComputedStyleForNodeRequest];
returnType: Protocol.CSS.GetComputedStyleForNodeResponse;
};
/**
* Returns the styles defined inline (explicitly in the "style" attribute and implicitly, using DOM
* attributes) for a DOM node identified by `nodeId`.
*/
'CSS.getInlineStylesForNode': {
paramsType: [Protocol.CSS.GetInlineStylesForNodeRequest]; returnType: Protocol.CSS.GetInlineStylesForNodeResponse;
};
/**
* Returns requested styles for a DOM node identified by `nodeId`.
*/
'CSS.getMatchedStylesForNode': {
paramsType: [Protocol.CSS.GetMatchedStylesForNodeRequest];
returnType: Protocol.CSS.GetMatchedStylesForNodeResponse;
};
/**
* Returns all media queries parsed by the rendering engine.
*/
'CSS.getMediaQueries': {paramsType: []; returnType: Protocol.CSS.GetMediaQueriesResponse;};
/**
* Requests information about platform fonts which we used to render child TextNodes in the given
* node.
*/
'CSS.getPlatformFontsForNode': {
paramsType: [Protocol.CSS.GetPlatformFontsForNodeRequest];
returnType: Protocol.CSS.GetPlatformFontsForNodeResponse;
};
/**
* Returns the current textual content for a stylesheet.
*/
'CSS.getStyleSheetText':
{paramsType: [Protocol.CSS.GetStyleSheetTextRequest]; returnType: Protocol.CSS.GetStyleSheetTextResponse;};
/**
* 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.
*/
'CSS.trackComputedStyleUpdates': {paramsType: [Protocol.CSS.TrackComputedStyleUpdatesRequest]; returnType: void;};
/**
* Polls the next batch of computed style updates.
*/
'CSS.takeComputedStyleUpdates': {paramsType: []; returnType: Protocol.CSS.TakeComputedStyleUpdatesResponse;};
/**
* Find a rule with the given active property for the given node and set the new value for this
* property
*/
'CSS.setEffectivePropertyValueForNode':
{paramsType: [Protocol.CSS.SetEffectivePropertyValueForNodeRequest]; returnType: void;};
/**
* Modifies the keyframe rule key text.
*/
'CSS.setKeyframeKey':
{paramsType: [Protocol.CSS.SetKeyframeKeyRequest]; returnType: Protocol.CSS.SetKeyframeKeyResponse;};
/**
* Modifies the rule selector.
*/
'CSS.setMediaText':
{paramsType: [Protocol.CSS.SetMediaTextRequest]; returnType: Protocol.CSS.SetMediaTextResponse;};
/**
* Modifies the rule selector.
*/
'CSS.setRuleSelector':
{paramsType: [Protocol.CSS.SetRuleSelectorRequest]; returnType: Protocol.CSS.SetRuleSelectorResponse;};
/**
* Sets the new stylesheet text.
*/
'CSS.setStyleSheetText':
{paramsType: [Protocol.CSS.SetStyleSheetTextRequest]; returnType: Protocol.CSS.SetStyleSheetTextResponse;};
/**
* Applies specified style edits one after another in the given order.
*/
'CSS.setStyleTexts':
{paramsType: [Protocol.CSS.SetStyleTextsRequest]; returnType: Protocol.CSS.SetStyleTextsResponse;};
/**
* Enables the selector recording.
*/
'CSS.startRuleUsageTracking': {paramsType: []; returnType: void;};
/**
* Stop tracking rule usage and return the list of rules that were used since last call to
* `takeCoverageDelta` (or since start of coverage instrumentation)
*/
'CSS.stopRuleUsageTracking': {paramsType: []; returnType: Protocol.CSS.StopRuleUsageTrackingResponse;};
/**
* Obtain list of rules that became used since last call to this method (or since start of coverage
* instrumentation)
*/
'CSS.takeCoverageDelta': {paramsType: []; returnType: Protocol.CSS.TakeCoverageDeltaResponse;};
/**
* Enables/disables rendering of local CSS fonts (enabled by default).
*/
'CSS.setLocalFontsEnabled': {paramsType: [Protocol.CSS.SetLocalFontsEnabledRequest]; returnType: void;};
/**
* Deletes a cache.
*/
'CacheStorage.deleteCache': {paramsType: [Protocol.CacheStorage.DeleteCacheRequest]; returnType: void;};
/**
* Deletes a cache entry.
*/
'CacheStorage.deleteEntry': {paramsType: [Protocol.CacheStorage.DeleteEntryRequest]; returnType: void;};
/**
* Requests cache names.
*/
'CacheStorage.requestCacheNames': {
paramsType: [Protocol.CacheStorage.RequestCacheNamesRequest];
returnType: Protocol.CacheStorage.RequestCacheNamesResponse;
};
/**
* Fetches cache entry.
*/
'CacheStorage.requestCachedResponse': {
paramsType: [Protocol.CacheStorage.RequestCachedResponseRequest];
returnType: Protocol.CacheStorage.RequestCachedResponseResponse;
};
/**
* Requests data from cache.
*/
'CacheStorage.requestEntries': {
paramsType: [Protocol.CacheStorage.RequestEntriesRequest];
returnType: Protocol.CacheStorage.RequestEntriesResponse;
};
/**
* 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.
*/
'Cast.enable': {paramsType: [Protocol.Cast.EnableRequest?]; returnType: void;};
/**
* Stops observing for sinks and issues.
*/
'Cast.disable': {paramsType: []; returnType: void;};
/**
* 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.
*/
'Cast.setSinkToUse': {paramsType: [Protocol.Cast.SetSinkToUseRequest]; returnType: void;};
/**
* Starts mirroring the tab to the sink.
*/
'Cast.startTabMirroring': {paramsType: [Protocol.Cast.StartTabMirroringRequest]; returnType: void;};
/**
* Stops the active Cast session on the sink.
*/
'Cast.stopCasting': {paramsType: [Protocol.Cast.StopCastingRequest]; returnType: void;};
/**
* Collects class names for the node with given id and all of it's child nodes.
*/
'DOM.collectClassNamesFromSubtree': {
paramsType: [Protocol.DOM.CollectClassNamesFromSubtreeRequest];
returnType: Protocol.DOM.CollectClassNamesFromSubtreeResponse;
};
/**
* Creates a deep copy of the specified node and places it into the target container before the
* given anchor.
*/
'DOM.copyTo': {paramsType: [Protocol.DOM.CopyToRequest]; returnType: Protocol.DOM.CopyToResponse;};
/**
* Describes node given its id, does not require domain to be enabled. Does not start tracking any
* objects, can be used for automation.
*/
'DOM.describeNode':
{paramsType: [Protocol.DOM.DescribeNodeRequest?]; returnType: Protocol.DOM.DescribeNodeResponse;};
/**
* 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.
*/
'DOM.scrollIntoViewIfNeeded': {paramsType: [Protocol.DOM.ScrollIntoViewIfNeededRequest?]; returnType: void;};
/**
* Disables DOM agent for the given page.
*/
'DOM.disable': {paramsType: []; returnType: void;};
/**
* Discards search results from the session with the given id. `getSearchResults` should no longer
* be called for that search.
*/
'DOM.discardSearchResults': {paramsType: [Protocol.DOM.DiscardSearchResultsRequest]; returnType: void;};
/**
* Enables DOM agent for the given page.
*/
'DOM.enable': {paramsType: []; returnType: void;};
/**
* Focuses the given element.
*/
'DOM.focus': {paramsType: [Protocol.DOM.FocusRequest?]; returnType: void;};
/**
* Returns attributes for the specified node.
*/
'DOM.getAttributes':
{paramsType: [Protocol.DOM.GetAttributesRequest]; returnType: Protocol.DOM.GetAttributesResponse;};
/**
* Returns boxes for the given node.
*/
'DOM.getBoxModel': {paramsType: [Protocol.DOM.GetBoxModelRequest?]; returnType: Protocol.DOM.GetBoxModelResponse;};
/**
* Returns quads that describe node position on the page. This method
* might return multiple quads for inline nodes.
*/
'DOM.getContentQuads':
{paramsType: [Protocol.DOM.GetContentQuadsRequest?]; returnType: Protocol.DOM.GetContentQuadsResponse;};
/**
* Returns the root DOM node (and optionally the subtree) to the caller.
*/
'DOM.getDocument': {paramsType: [Protocol.DOM.GetDocumentRequest?]; returnType: Protocol.DOM.GetDocumentResponse;};
/**
* 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.
*/
'DOM.getFlattenedDocument': {
paramsType: [Protocol.DOM.GetFlattenedDocumentRequest?]; returnType: Protocol.DOM.GetFlattenedDocumentResponse;
};
/**
* Finds nodes with a given computed style in a subtree.
*/
'DOM.getNodesForSubtreeByStyle': {
paramsType: [Protocol.DOM.GetNodesForSubtreeByStyleRequest];
returnType: Protocol.DOM.GetNodesForSubtreeByStyleResponse;
};
/**
* Returns node id at given location. Depending on whether DOM domain is enabled, nodeId is
* either returned or not.
*/
'DOM.getNodeForLocation':
{paramsType: [Protocol.DOM.GetNodeForLocationRequest]; returnType: Protocol.DOM.GetNodeForLocationResponse;};
/**
* Returns node's HTML markup.
*/
'DOM.getOuterHTML':
{paramsType: [Protocol.DOM.GetOuterHTMLRequest?]; returnType: Protocol.DOM.GetOuterHTMLResponse;};
/**
* Returns the id of the nearest ancestor that is a relayout boundary.
*/
'DOM.getRelayoutBoundary':
{paramsType: [Protocol.DOM.GetRelayoutBoundaryRequest]; returnType: Protocol.DOM.GetRelayoutBoundaryResponse;};
/**
* Returns search results from given `fromIndex` to given `toIndex` from the search with the given
* identifier.
*/
'DOM.getSearchResults':
{paramsType: [Protocol.DOM.GetSearchResultsRequest]; returnType: Protocol.DOM.GetSearchResultsResponse;};
/**
* Hides any highlight.
*/
'DOM.hideHighlight': {paramsType: []; returnType: void;};
/**
* Highlights DOM node.
*/
'DOM.highlightNode': {paramsType: []; returnType: void;};
/**
* Highlights given rectangle.
*/
'DOM.highlightRect': {paramsType: []; returnType: void;};
/**
* Marks last undoable state.
*/
'DOM.markUndoableState': {paramsType: []; returnType: void;};
/**
* Moves node into the new container, places it before the given anchor.
*/
'DOM.moveTo': {paramsType: [Protocol.DOM.MoveToRequest]; returnType: Protocol.DOM.MoveToResponse;};
/**
* Searches for a given string in the DOM tree. Use `getSearchResults` to access search results or
* `cancelSearch` to end this search session.
*/
'DOM.performSearch':
{paramsType: [Protocol.DOM.PerformSearchRequest]; returnType: Protocol.DOM.PerformSearchResponse;};
/**
* Requests that the node is sent to the caller given its path. // FIXME, use XPath
*/
'DOM.pushNodeByPathToFrontend': {
paramsTy