BlockingResponse constructor

BlockingResponse({ bool? cancel, String? redirectUrl, List<HttpHeadersItems>? requestHeaders, List<HttpHeadersItems>? responseHeaders, BlockingResponseAuthCredentials? authCredentials, })

Implementation

BlockingResponse({
  /// If true, the request is cancelled. This prevents the request from being
  /// sent. This can be used as a response to the onBeforeRequest,
  /// onBeforeSendHeaders, onHeadersReceived and onAuthRequired events.
  bool? cancel,

  /// Only used as a response to the onBeforeRequest and onHeadersReceived
  /// events. If set, the original request is prevented from being
  /// sent/completed and is instead redirected to the given URL. Redirections
  /// to non-HTTP schemes such as `data:` are allowed. Redirects initiated by
  /// a redirect action use the original request method for the redirect, with
  /// one exception: If the redirect is initiated at the onHeadersReceived
  /// stage, then the redirect will be issued using the GET method. Redirects
  /// from URLs with `ws://` and `wss://` schemes are **ignored**.
  String? redirectUrl,

  /// Only used as a response to the onBeforeSendHeaders event. If set, the
  /// request is made with these request headers instead.
  List<HttpHeadersItems>? requestHeaders,

  /// Only used as a response to the onHeadersReceived event. If set, the
  /// server is assumed to have responded with these response headers instead.
  /// Only return `responseHeaders` if you really want to modify the headers
  /// in order to limit the number of conflicts (only one extension may modify
  /// `responseHeaders` for each request).
  List<HttpHeadersItems>? responseHeaders,

  /// Only used as a response to the onAuthRequired event. If set, the request
  /// is made using the supplied credentials.
  BlockingResponseAuthCredentials? authCredentials,
}) : _wrapped = $js.BlockingResponse(
        cancel: cancel,
        redirectUrl: redirectUrl,
        requestHeaders: requestHeaders?.toJSArray((e) => e.toJS),
        responseHeaders: responseHeaders?.toJSArray((e) => e.toJS),
        authCredentials: authCredentials?.toJS,
      );