chromiumoxide::cdp::browser_protocol

Module network

Source
Expand description

Network domain allows tracking network activities of the page. It exposes information about http, file, data and other requests and responses, their headers, bodies, timing, etc.

Structs§

AssociatedCookie
A cookie associated with the request which may or may not be sent with it. Includes the cookies itself and reasons for blocking or exemption. AssociatedCookie
AssociatedCookieBuilder
AuthChallenge
Authorization challenge for HTTP status code 401 or 407. AuthChallenge
AuthChallengeBuilder
AuthChallengeResponse
Response to an AuthChallenge. AuthChallengeResponse
AuthChallengeResponseBuilder
BlockedSetCookieWithReason
A cookie which was not stored from a response with the corresponding reason. BlockedSetCookieWithReason
BlockedSetCookieWithReasonBuilder
CachedResource
Information about the cached resource. CachedResource
CachedResourceBuilder
ClearAcceptedEncodingsOverrideParams
Clears accepted encodings set by setAcceptedEncodings clearAcceptedEncodingsOverride
ClearAcceptedEncodingsOverrideReturns
Clears accepted encodings set by setAcceptedEncodings clearAcceptedEncodingsOverride
ClearBrowserCacheParams
Clears browser cache. clearBrowserCache
ClearBrowserCacheReturns
Clears browser cache. clearBrowserCache
ClearBrowserCookiesParams
Clears browser cookies. clearBrowserCookies
ClearBrowserCookiesReturns
Clears browser cookies. clearBrowserCookies
ClientSecurityState
ClientSecurityStateBuilder
ConnectTiming
ConnectTimingBuilder
ContentSecurityPolicyStatus
ContentSecurityPolicyStatusBuilder
Cookie
Cookie object Cookie
CookieBuilder
CookieParam
Cookie parameter object CookieParam
CookieParamBuilder
CookiePartitionKey
cookiePartitionKey object The representation of the components of the key that are created by the cookiePartitionKey class contained in net/cookies/cookie_partition_key.h. CookiePartitionKey
CookiePartitionKeyBuilder
CorsErrorStatus
CorsErrorStatusBuilder
CrossOriginEmbedderPolicyStatus
CrossOriginEmbedderPolicyStatusBuilder
CrossOriginOpenerPolicyStatus
CrossOriginOpenerPolicyStatusBuilder
DeleteCookiesParams
Deletes browser cookies with matching name and url or domain/path/partitionKey pair. deleteCookies
DeleteCookiesParamsBuilder
DeleteCookiesReturns
Deletes browser cookies with matching name and url or domain/path/partitionKey pair. deleteCookies
DisableParams
Disables network tracking, prevents network events from being sent to the client. disable
DisableReturns
Disables network tracking, prevents network events from being sent to the client. disable
EmulateNetworkConditionsParams
Activates emulation of network conditions. emulateNetworkConditions
EmulateNetworkConditionsParamsBuilder
EmulateNetworkConditionsReturns
Activates emulation of network conditions. emulateNetworkConditions
EnableParams
Enables network tracking, network events will now be delivered to the client. enable
EnableParamsBuilder
EnableReportingApiParams
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. enableReportingApi
EnableReportingApiParamsBuilder
EnableReportingApiReturns
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. enableReportingApi
EnableReturns
Enables network tracking, network events will now be delivered to the client. enable
EventDataReceived
Fired when data chunk was received over the network. dataReceived
EventEventSourceMessageReceived
Fired when EventSource message is received. eventSourceMessageReceived
EventLoadingFailed
Fired when HTTP request has failed to load. loadingFailed
EventLoadingFinished
Fired when HTTP request has finished loading. loadingFinished
EventPolicyUpdated
Fired once security policy has been updated. policyUpdated
EventReportingApiEndpointsChangedForOrigin
EventReportingApiReportAdded
Is sent whenever a new report is added. And after ‘enableReportingApi’ for all existing reports. reportingApiReportAdded
EventReportingApiReportUpdated
EventRequestServedFromCache
Fired if request ended up loading from cache. requestServedFromCache
EventRequestWillBeSent
Fired when page is about to send HTTP request. requestWillBeSent
EventRequestWillBeSentExtraInfo
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
EventResourceChangedPriority
Fired when resource loading priority is changed resourceChangedPriority
EventResponseReceived
Fired when HTTP response is available. responseReceived
EventResponseReceivedEarlyHints
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
EventResponseReceivedExtraInfo
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
EventSignedExchangeReceived
Fired when a signed exchange was received over the network signedExchangeReceived
EventSubresourceWebBundleInnerResponseError
Fired when request for resources within a .wbn file failed. subresourceWebBundleInnerResponseError
EventSubresourceWebBundleInnerResponseParsed
Fired when handling requests for resources within a .wbn file. Note: this will only be fired for resources that are requested by the webpage. subresourceWebBundleInnerResponseParsed
EventSubresourceWebBundleMetadataError
Fired once when parsing the .wbn file has failed. subresourceWebBundleMetadataError
EventSubresourceWebBundleMetadataReceived
Fired once when parsing the .wbn file has succeeded. The event contains the information about the web bundle contents. subresourceWebBundleMetadataReceived
EventTrustTokenOperationDone
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
EventWebSocketClosed
Fired when WebSocket is closed. webSocketClosed
EventWebSocketCreated
Fired upon WebSocket creation. webSocketCreated
EventWebSocketFrameError
Fired when WebSocket message error occurs. webSocketFrameError
EventWebSocketFrameReceived
Fired when WebSocket message is received. webSocketFrameReceived
EventWebSocketFrameSent
Fired when WebSocket message is sent. webSocketFrameSent
EventWebSocketHandshakeResponseReceived
Fired when WebSocket handshake response becomes available. webSocketHandshakeResponseReceived
EventWebSocketWillSendHandshakeRequest
Fired when WebSocket is about to initiate handshake. webSocketWillSendHandshakeRequest
EventWebTransportClosed
Fired when WebTransport is disposed. webTransportClosed
EventWebTransportConnectionEstablished
Fired when WebTransport handshake is finished. webTransportConnectionEstablished
EventWebTransportCreated
Fired upon WebTransport creation. webTransportCreated
ExemptedSetCookieWithReason
A cookie should have been blocked by 3PCD but is exempted and stored from a response with the corresponding reason. A cookie could only have at most one exemption reason. ExemptedSetCookieWithReason
ExemptedSetCookieWithReasonBuilder
GetCertificateParams
Returns the DER-encoded certificate. getCertificate
GetCertificateParamsBuilder
GetCertificateReturns
Returns the DER-encoded certificate. getCertificate
GetCertificateReturnsBuilder
GetCookiesParams
Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field. getCookies
GetCookiesParamsBuilder
GetCookiesReturns
Returns all browser cookies for the current URL. Depending on the backend support, will return detailed cookie information in the cookies field. getCookies
GetCookiesReturnsBuilder
GetRequestPostDataParams
Returns post data sent with the request. Returns an error when no data was sent with the request. getRequestPostData
GetRequestPostDataParamsBuilder
GetRequestPostDataReturns
Returns post data sent with the request. Returns an error when no data was sent with the request. getRequestPostData
GetRequestPostDataReturnsBuilder
GetResponseBodyForInterceptionParams
Returns content served for the given currently intercepted request. getResponseBodyForInterception
GetResponseBodyForInterceptionParamsBuilder
GetResponseBodyForInterceptionReturns
Returns content served for the given currently intercepted request. getResponseBodyForInterception
GetResponseBodyForInterceptionReturnsBuilder
GetResponseBodyParams
Returns content served for the given request. getResponseBody
GetResponseBodyParamsBuilder
GetResponseBodyReturns
Returns content served for the given request. getResponseBody
GetResponseBodyReturnsBuilder
GetSecurityIsolationStatusParams
Returns information about the COEP/COOP isolation status. getSecurityIsolationStatus
GetSecurityIsolationStatusParamsBuilder
GetSecurityIsolationStatusReturns
Returns information about the COEP/COOP isolation status. getSecurityIsolationStatus
GetSecurityIsolationStatusReturnsBuilder
Headers
Request / response headers as keys / values of JSON object. Headers
Initiator
Information about the request initiator. Initiator
InitiatorBuilder
InterceptionId
Unique intercepted request identifier. InterceptionId
LoadNetworkResourceOptions
An options object that may be extended later to better support CORS, CORB and streaming. LoadNetworkResourceOptions
LoadNetworkResourceOptionsBuilder
LoadNetworkResourcePageResult
An object providing the result of a network resource load. LoadNetworkResourcePageResult
LoadNetworkResourcePageResultBuilder
LoadNetworkResourceParams
Fetches the resource and returns the content. loadNetworkResource
LoadNetworkResourceParamsBuilder
LoadNetworkResourceReturns
Fetches the resource and returns the content. loadNetworkResource
LoadNetworkResourceReturnsBuilder
LoaderId
Unique loader identifier. LoaderId
MonotonicTime
Monotonically increasing time in seconds since an arbitrary point in the past. MonotonicTime
PostDataEntry
Post data entry for HTTP request PostDataEntry
PostDataEntryBuilder
ReplayXhrParams
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. replayXHR
ReplayXhrParamsBuilder
ReplayXhrReturns
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. replayXHR
ReportId
ReportingApiEndpoint
ReportingApiEndpointBuilder
ReportingApiReport
An object representing a report generated by the Reporting API. ReportingApiReport
ReportingApiReportBuilder
Request
HTTP request data. Request
RequestBuilder
RequestId
Unique request identifier. RequestId
RequestPattern
Request pattern for interception. RequestPattern
RequestPatternBuilder
ResourceTiming
Timing information for the request. ResourceTiming
ResourceTimingBuilder
Response
HTTP response data. Response
ResponseBuilder
SearchInResponseBodyParams
Searches for given string in response content. searchInResponseBody
SearchInResponseBodyParamsBuilder
SearchInResponseBodyReturns
Searches for given string in response content. searchInResponseBody
SearchInResponseBodyReturnsBuilder
SecurityDetails
Security details about a request. SecurityDetails
SecurityDetailsBuilder
SecurityIsolationStatus
SecurityIsolationStatusBuilder
ServiceWorkerRouterInfo
ServiceWorkerRouterInfoBuilder
SetAcceptedEncodingsParams
Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted. setAcceptedEncodings
SetAcceptedEncodingsParamsBuilder
SetAcceptedEncodingsReturns
Sets a list of content encodings that will be accepted. Empty list means no encoding is accepted. setAcceptedEncodings
SetAttachDebugStackParams
Specifies whether to attach a page script stack id in requests setAttachDebugStack
SetAttachDebugStackParamsBuilder
SetAttachDebugStackReturns
Specifies whether to attach a page script stack id in requests setAttachDebugStack
SetBlockedUrLsParams
Blocks URLs from loading. setBlockedURLs
SetBlockedUrLsParamsBuilder
SetBlockedUrLsReturns
Blocks URLs from loading. setBlockedURLs
SetBypassServiceWorkerParams
Toggles ignoring of service worker for each request. setBypassServiceWorker
SetBypassServiceWorkerParamsBuilder
SetBypassServiceWorkerReturns
Toggles ignoring of service worker for each request. setBypassServiceWorker
SetCacheDisabledParams
Toggles ignoring cache for each request. If true, cache will not be used. setCacheDisabled
SetCacheDisabledParamsBuilder
SetCacheDisabledReturns
Toggles ignoring cache for each request. If true, cache will not be used. setCacheDisabled
SetCookieParams
Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. setCookie
SetCookieParamsBuilder
SetCookieReturns
Sets a cookie with the given cookie data; may overwrite equivalent cookies if they exist. setCookie
SetCookiesParams
Sets given cookies. setCookies
SetCookiesParamsBuilder
SetCookiesReturns
Sets given cookies. setCookies
SetExtraHttpHeadersParams
Specifies whether to always send extra HTTP headers with the requests from this page. setExtraHTTPHeaders
SetExtraHttpHeadersParamsBuilder
SetExtraHttpHeadersReturns
Specifies whether to always send extra HTTP headers with the requests from this page. setExtraHTTPHeaders
SetUserAgentOverrideParams
Allows overriding user agent with the given string. setUserAgentOverride
SetUserAgentOverrideParamsBuilder
SetUserAgentOverrideReturns
Allows overriding user agent with the given string. setUserAgentOverride
SignedCertificateTimestamp
Details of a signed certificate timestamp (SCT). SignedCertificateTimestamp
SignedCertificateTimestampBuilder
SignedExchangeError
Information about a signed exchange response. SignedExchangeError
SignedExchangeErrorBuilder
SignedExchangeHeader
Information about a signed exchange header. https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#cbor-representation SignedExchangeHeader
SignedExchangeHeaderBuilder
SignedExchangeInfo
Information about a signed exchange response. SignedExchangeInfo
SignedExchangeInfoBuilder
SignedExchangeSignature
Information about a signed exchange signature. https://wicg.github.io/webpackage/draft-yasskin-httpbis-origin-signed-exchanges-impl.html#rfc.section.3.1 SignedExchangeSignature
SignedExchangeSignatureBuilder
StreamResourceContentParams
Enables streaming of the response for the given requestId. If enabled, the dataReceived event contains the data that was received during streaming. streamResourceContent
StreamResourceContentParamsBuilder
StreamResourceContentReturns
Enables streaming of the response for the given requestId. If enabled, the dataReceived event contains the data that was received during streaming. streamResourceContent
StreamResourceContentReturnsBuilder
TakeResponseBodyForInterceptionAsStreamParams
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. takeResponseBodyForInterceptionAsStream
TakeResponseBodyForInterceptionAsStreamParamsBuilder
TakeResponseBodyForInterceptionAsStreamReturns
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. takeResponseBodyForInterceptionAsStream
TakeResponseBodyForInterceptionAsStreamReturnsBuilder
TimeSinceEpoch
UTC time in seconds, counted from January 1, 1970. TimeSinceEpoch
TrustTokenParams
Determines what type of Trust Token operation is executed and depending on the type, some additional parameters. The values are specified in third_party/blink/renderer/core/fetch/trust_token.idl. TrustTokenParams
TrustTokenParamsBuilder
WebSocketFrame
WebSocket message data. This represents an entire WebSocket message, not just a fragmented frame as the name suggests. WebSocketFrame
WebSocketFrameBuilder
WebSocketRequest
WebSocket request data. WebSocketRequest
WebSocketRequestBuilder
WebSocketResponse
WebSocket response data. WebSocketResponse
WebSocketResponseBuilder

Enums§

AlternateProtocolUsage
The reason why Chrome uses a specific transport protocol for HTTP semantics.
AuthChallengeResponseResponse
The decision on what to do in response to the authorization challenge. Default means deferring to the default behavior of the net stack, which will likely either the Cancel authentication or display a popup dialog box.
AuthChallengeSource
Source of the authentication challenge.
BlockedReason
The reason why request was blocked.
CertificateTransparencyCompliance
Whether the request complied with Certificate Transparency policy.
ConnectionType
The underlying connection technology that the browser is supposedly using.
ContentEncoding
List of content encodings supported by the backend.
ContentSecurityPolicySource
CookieBlockedReason
Types of reasons why a cookie may not be sent with a request.
CookieExemptionReason
Types of reasons why a cookie should have been blocked by 3PCD but is exempted for the request.
CookiePriority
Represents the cookie’s ‘Priority’ status: https://tools.ietf.org/html/draft-west-cookie-priority-00
CookieSameSite
Represents the cookie’s ‘SameSite’ status: https://tools.ietf.org/html/draft-west-first-party-cookies
CookieSourceScheme
Represents the source scheme of the origin that originally set the cookie. A value of “Unset” allows protocol clients to emulate legacy cookie scope for the scheme. This is a temporary ability and it will be removed in the future.
CorsError
The reason why request was blocked.
CrossOriginEmbedderPolicyValue
CrossOriginOpenerPolicyValue
ErrorReason
Network level fetch failure reason.
InitiatorType
Type of this initiator.
InterceptionStage
Stages of the interception to begin intercepting. Request will intercept before the request is sent. Response will intercept after the response is received.
IpAddressSpace
PrivateNetworkRequestPolicy
ReportStatus
The status of a Reporting API report.
RequestReferrerPolicy
The referrer policy of the request, as defined in https://www.w3.org/TR/referrer-policy/
ResourcePriority
Loading priority of a resource request.
ResourceType
Resource type as it was perceived by the rendering engine.
ServiceWorkerResponseSource
Source of serviceworker response.
ServiceWorkerRouterSource
Source of service worker router.
SetCookieBlockedReason
Types of reasons why a cookie may not be stored from a response.
SignedExchangeErrorField
Field type for a signed exchange related error.
TrustTokenOperationDoneStatus
Detailed success or error status of the operation. ‘AlreadyExists’ also signifies a successful operation, as the result of the operation already exists und thus, the operation was abort preemptively (e.g. a cache hit).
TrustTokenOperationType
TrustTokenParamsRefreshPolicy
Only set for “token-redemption” operation and determine whether to request a fresh SRR or use a still valid cached SRR.