chrome-devtools-kotlin / org.hildan.chrome.devtools.domains.fetch / FetchDomain

FetchDomain

class FetchDomain

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

Official doc

Functions

authRequired

Issued when the domain is enabled with handleAuthRequests set to true. The request is paused until client responds with continueWithAuth.

fun authRequired(): Flow<AuthRequiredEvent>

continueRequest

Continues the request, optionally modifying some of its parameters.

suspend fun continueRequest(input: ContinueRequestRequest): Unit

continueWithAuth

Continues a request supplying authChallengeResponse following authRequired event.

suspend fun continueWithAuth(input: ContinueWithAuthRequest): Unit

disable

Disables the fetch domain.

suspend fun disable(): Unit

enable

Enables issuing of requestPaused events. A request will be paused until client calls one of failRequest, fulfillRequest or continueRequest/continueWithAuth.

suspend fun enable(input: EnableRequest): Unit

events

Subscribes to all events related to this domain.

fun events(): Flow<FetchEvent>

failRequest

Causes the request to fail with specified reason.

suspend fun failRequest(input: FailRequestRequest): Unit

fulfillRequest

Provides response to the request.

suspend fun fulfillRequest(input: FulfillRequestRequest): Unit

getResponseBody

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.

suspend fun getResponseBody(input: GetResponseBodyRequest): GetResponseBodyResponse

requestPaused

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.

fun requestPaused(): Flow<RequestPausedEvent>

takeResponseBodyAsStream

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.

suspend fun takeResponseBodyAsStream(input: TakeResponseBodyAsStreamRequest): TakeResponseBodyAsStreamResponse