pl.wendigo.chrome.api.fetch / FetchOperations

FetchOperations

class FetchOperations (source)

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

This API is marked as experimental in protocol definition and can change in the future.

Link
Protocol Fetch domain documentation.

Functions

authRequired

fun authRequired(): Flowable<AuthRequiredEvent>

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

continueRequest

fun continueRequest(input: ContinueRequestRequest): Single<ResponseFrame>

Continues the request, optionally modifying some of its parameters.

continueWithAuth

fun continueWithAuth(input: ContinueWithAuthRequest): Single<ResponseFrame>

Continues a request supplying authChallengeResponse following authRequired event.

disable

fun disable(): Single<ResponseFrame>

Disables the fetch domain.

enable

fun enable(input: EnableRequest): Single<ResponseFrame>

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

events

fun events(): Flowable<Event>

Returns flowable capturing all Fetch domains events.

failRequest

fun failRequest(input: FailRequestRequest): Single<ResponseFrame>

Causes the request to fail with specified reason.

fulfillRequest

fun fulfillRequest(input: FulfillRequestRequest): Single<ResponseFrame>

Provides response to the request.

getResponseBody

fun getResponseBody(input: GetResponseBodyRequest): Single<GetResponseBodyResponse>

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.

requestPaused

fun requestPaused(): Flowable<RequestPausedEvent>

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.

takeResponseBodyAsStream

fun takeResponseBodyAsStream(input: TakeResponseBodyAsStreamRequest): Single<TakeResponseBodyAsStreamResponse>

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.