scala-js-chrome/chrome.webRequest.bindings/WebRequest

WebRequest

@native @JSGlobal("chrome.webRequest") @JSType
object WebRequest extends Object
class Object
trait Any
class Object
trait Matchable
class Any

Type members

Types

type BlockableAuthCallback[R <: ResourceRequest] = Function2[R, UndefOr[Function1[BlockingResponse, _]], UndefOr[BlockingResponse]]
type BlockableCallback[R <: ResourceRequest] = Function1[R, UndefOr[BlockingResponse]]
type Callback[R <: ResourceRequest] = Function1[R, Unit]

Value members

Concrete methods

def handlerBehaviorChanged(callback: UndefOr[Function0[_]]): Unit

Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.

Needs to be called when the behavior of the webRequest handlers has changed to prevent incorrect handling due to caching. This function call is expensive. Don't call it often.

Inherited methods

def hasOwnProperty(v: String): Boolean
Inherited from
Object
def isPrototypeOf(v: Object): Boolean
Inherited from
Object
def propertyIsEnumerable(v: String): Boolean
Inherited from
Object
def toLocaleString(): String
Inherited from
Object
def valueOf(): Any
Inherited from
Object

Concrete fields

val MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES: Int

The maximum number of times that handlerBehaviorChanged can be called per 10 minute sustained interval. handlerBehaviorChanged is an expensive function call that shouldn't be called often.

The maximum number of times that handlerBehaviorChanged can be called per 10 minute sustained interval. handlerBehaviorChanged is an expensive function call that shouldn't be called often.

Since

Chrome 23.

var onAuthRequired: WebRequestEvent[BlockableAuthCallback[WebAuthenticationChallengeDetails]]

Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request.

Fired when an authentication failure is received. The listener has three options: it can provide authentication credentials, it can cancel the request and display the error page, or it can take no action on the challenge. If bad user credentials are provided, this may be called multiple times for the same request.

var onBeforeRedirect: WebRequestEvent[Callback[WebRedirectionResponseDetails]]

Fired when a server-initiated redirect is about to occur.

Fired when a server-initiated redirect is about to occur.

var onBeforeRequest: WebRequestEvent[BlockableCallback[WebRequestBodyDetails]]

Fired when a request is about to occur.

Fired when a request is about to occur.

var onBeforeSendHeaders: WebRequestEvent[BlockableCallback[WebRequestHeadersDetails]]

Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent.

Fired before sending an HTTP request, once the request headers are available. This may occur after a TCP connection is made to the server, but before any HTTP data is sent.

var onCompleted: WebRequestEvent[Callback[WebResponseCacheDetails]]

Fired when a request is completed.

Fired when a request is completed.

var onErrorOccurred: WebRequestEvent[Callback[WebResponseErrorDetails]]

Fired when an error occurs.

Fired when an error occurs.

val onHeadersReceived: WebRequestEvent[BlockableCallback[WebResponseHeadersDetails]]

Fired when HTTP response headers of a request have been received.

Fired when HTTP response headers of a request have been received.

var onResponseStarted: WebRequestEvent[Callback[WebResponseCacheDetails]]

Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.

Fired when the first byte of the response body is received. For HTTP requests, this means that the status line and response headers are available.

var onSendHeaders: WebRequestEvent[Callback[WebRequestHeadersDetails]]

Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).

Fired just before a request is going to be sent to the server (modifications of previous onBeforeSendHeaders callbacks are visible by the time onSendHeaders is fired).