Module fetch

Source
Expand description

A domain for letting clients substitute browser’s network layer with client code.

Structs§

AuthChallenge
Authorization challenge for HTTP status code 401 or 407. AuthChallenge
AuthChallengeBuilder
AuthChallengeResponse
Response to an AuthChallenge. AuthChallengeResponse
AuthChallengeResponseBuilder
ContinueRequestParams
Continues the request, optionally modifying some of its parameters. continueRequest
ContinueRequestParamsBuilder
ContinueRequestReturns
Continues the request, optionally modifying some of its parameters. continueRequest
ContinueResponseParams
Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present. continueResponse
ContinueResponseParamsBuilder
ContinueResponseReturns
Continues loading of the paused response, optionally modifying the response headers. If either responseCode or headers are modified, all of them must be present. continueResponse
ContinueWithAuthParams
Continues a request supplying authChallengeResponse following authRequired event. continueWithAuth
ContinueWithAuthParamsBuilder
ContinueWithAuthReturns
Continues a request supplying authChallengeResponse following authRequired event. continueWithAuth
DisableParams
Disables the fetch domain. disable
DisableReturns
Disables the fetch domain. disable
EnableParams
Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth. enable
EnableParamsBuilder
EnableReturns
Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth. enable
EventAuthRequired
Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth. authRequired
EventRequestPaused
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
FailRequestParams
Causes the request to fail with specified reason. failRequest
FailRequestParamsBuilder
FailRequestReturns
Causes the request to fail with specified reason. failRequest
FulfillRequestParams
Provides response to the request. fulfillRequest
FulfillRequestParamsBuilder
FulfillRequestReturns
Provides response to the request. fulfillRequest
GetResponseBodyParams
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. getResponseBody
GetResponseBodyParamsBuilder
GetResponseBodyReturns
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. getResponseBody
GetResponseBodyReturnsBuilder
HeaderEntry
Response HTTP header entry HeaderEntry
HeaderEntryBuilder
RequestId
Unique request identifier. RequestId
RequestPattern
RequestPatternBuilder
TakeResponseBodyAsStreamParams
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. takeResponseBodyAsStream
TakeResponseBodyAsStreamParamsBuilder
TakeResponseBodyAsStreamReturns
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. takeResponseBodyAsStream
TakeResponseBodyAsStreamReturnsBuilder

Enums§

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.
RequestStage
Stages of the request to handle. Request will intercept before the request is sent. Response will intercept after the response is received (but before response body is received).