Method Detail

• events

   final Flow<FetchEvent> events()

  Subscribes to all events related to this domain.

• requestPaused

   final Flow<FetchEvent.RequestPausedEvent> 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.

  Official doc

• authRequired

   final Flow<FetchEvent.AuthRequiredEvent> authRequired()

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

  Official doc

• disable

   final Unit disable()

  Disables the fetch domain.

  Official doc

• enable

   final Unit enable(EnableRequest input)

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

  Official doc

• failRequest

   final Unit failRequest(FailRequestRequest input)

  Causes the request to fail with specified reason.

  Official doc

• fulfillRequest

   final Unit fulfillRequest(FulfillRequestRequest input)

  Provides response to the request.

  Official doc

• continueRequest

   final Unit continueRequest(ContinueRequestRequest input)

  Continues the request, optionally modifying some of its parameters.

  Official doc

• continueWithAuth

   final Unit continueWithAuth(ContinueWithAuthRequest input)

  Continues a request supplying authChallengeResponse following authRequired event.

  Official doc

• getResponseBody

   final GetResponseBodyResponse getResponseBody(GetResponseBodyRequest input)

  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.

  Official doc

• takeResponseBodyAsStream

   final TakeResponseBodyAsStreamResponse takeResponseBodyAsStream(TakeResponseBodyAsStreamRequest input)

  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.

  Official doc