chromex.ext.web-request — binaryage/chromex 0.6.4

clj

Use the chrome.webRequest API to observe and analyze traffic and to intercept, block, or modify requests in-flight.

• available since Chrome 26
• https://developer.chrome.com/extensions/webRequest

api-table clj

gen-call clj

gen-wrap clj/s macro

(gen-wrap kind item-id config & args)

get-max-handler-behavior-changed-calls-per10-minutes clj/s macro

(get-max-handler-behavior-changed-calls-per10-minutes)

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.

https://developer.chrome.com/extensions/webRequest#property-MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES.

handler-behavior-changed clj/s macro

(handler-behavior-changed)

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.

This function returns a core.async channel of type promise-chan which eventually receives a result value. Signature of the result value put on the channel is [].

In case of an error the channel closes without receiving any value and relevant error object can be obtained via chromex.error/get-last-error.

https://developer.chrome.com/extensions/webRequest#method-handlerBehaviorChanged.

handler-behavior-changed* cljs

(handler-behavior-changed* config)

max-handler-behavior-changed-calls-per10-minutes* cljs

(max-handler-behavior-changed-calls-per10-minutes* config)

on-action-ignored* cljs

(on-action-ignored* config channel & args)

on-auth-required* cljs

(on-auth-required* config channel & args)

on-before-redirect* cljs

(on-before-redirect* config channel & args)

on-before-request* cljs

(on-before-request* config channel & args)

on-before-send-headers* cljs

(on-before-send-headers* config channel & args)

on-completed* cljs

(on-completed* config channel & args)

on-error-occurred* cljs

(on-error-occurred* config channel & args)

on-headers-received* cljs

(on-headers-received* config channel & args)

on-response-started* cljs

(on-response-started* config channel & args)

on-send-headers* cljs

(on-send-headers* config channel & args)

tap-all-events clj/s macro

(tap-all-events chan)

Taps all valid non-deprecated events in chromex.ext.web-request namespace.

tap-on-action-ignored-events clj/s macro

(tap-on-action-ignored-events channel & args)

Fired when an extension's proposed modification to a network request is ignored. This happens in case of conflicts with other extensions.

Events will be put on the |channel| with signature [::on-action-ignored [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onActionIgnored-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onActionIgnored.

tap-on-auth-required-events clj/s macro

(tap-on-auth-required-events channel & args)

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. Note, only one of 'blocking' or 'asyncBlocking' modes must be specified in the extraInfoSpec parameter.

Events will be put on the |channel| with signature [::on-auth-required [details async-callback]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onAuthRequired-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onAuthRequired.

tap-on-before-redirect-events clj/s macro

(tap-on-before-redirect-events channel & args)

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

Events will be put on the |channel| with signature [::on-before-redirect [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onBeforeRedirect-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onBeforeRedirect.

tap-on-before-request-events clj/s macro

(tap-on-before-request-events channel & args)

Fired when a request is about to occur.

Events will be put on the |channel| with signature [::on-before-request [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onBeforeRequest-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onBeforeRequest.

tap-on-before-send-headers-events clj/s macro

(tap-on-before-send-headers-events channel & args)

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.

Events will be put on the |channel| with signature [::on-before-send-headers [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onBeforeSendHeaders-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onBeforeSendHeaders.

tap-on-completed-events clj/s macro

(tap-on-completed-events channel & args)

Fired when a request is completed.

Events will be put on the |channel| with signature [::on-completed [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onCompleted-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onCompleted.

tap-on-error-occurred-events clj/s macro

(tap-on-error-occurred-events channel & args)

Fired when an error occurs.

Events will be put on the |channel| with signature [::on-error-occurred [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onErrorOccurred-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onErrorOccurred.

tap-on-headers-received-events clj/s macro

(tap-on-headers-received-events channel & args)

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

Events will be put on the |channel| with signature [::on-headers-received [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onHeadersReceived-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onHeadersReceived.

tap-on-response-started-events clj/s macro

(tap-on-response-started-events channel & args)

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.

Events will be put on the |channel| with signature [::on-response-started [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onResponseStarted-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onResponseStarted.

tap-on-send-headers-events clj/s macro

(tap-on-send-headers-events channel & args)

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).

Events will be put on the |channel| with signature [::on-send-headers [details]] where:

|details| - https://developer.chrome.com/extensions/webRequest#property-onSendHeaders-details.

Note: |args| will be passed as additional parameters into Chrome event's .addListener call.

https://developer.chrome.com/extensions/webRequest#event-onSendHeaders.