chromex.ext.declarative-net-request — binaryage/chromex 0.8.6

clj

The chrome.declarativeNetRequest API is used to block or modify network requests by specifying declarative rules.

• available since Chrome 80
• https://developer.chrome.com/extensions/declarativeNetRequest

api-table clj

gen-call clj

gen-wrap clj/s macro

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

get-dynamic-rules clj/s macro

(get-dynamic-rules)

Returns the current set of dynamic rules for the extension.

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 [rules] where:

|rules| - https://developer.chrome.com/extensions/declarativeNetRequest#property-callback-rules.

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/declarativeNetRequest#method-getDynamicRules.

get-dynamic-rules* cljs

(get-dynamic-rules* config)

get-getmatchedrules-quota-interval clj/s macro

(get-getmatchedrules-quota-interval)

Time interval within which MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL getMatchedRules calls can be made, specified in minutes. Additional calls will fail immediately and set 'runtime.lastError'.

https://developer.chrome.com/extensions/declarativeNetRequest#property-GETMATCHEDRULES_QUOTA_INTERVAL.

get-matched-rules clj/s macro

(get-matched-rules)

(get-matched-rules filter)

Returns all rules matched for the extension. Callers can optionally filter the list of matched rules by specifying a |filter|. This method is only available to extensions with the declarativeNetRequestFeedback permission or having the activeTab permission granted for the tabId specified in filter. Note: Rules not associated with an active document that were matched more than five minutes ago will not be returned.

|filter| - An object to filter the list of matched rules.

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 [details] where:

|details| - https://developer.chrome.com/extensions/declarativeNetRequest#property-callback-details.

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/declarativeNetRequest#method-getMatchedRules.

get-matched-rules* cljs

(get-matched-rules* config filter)

get-max-getmatchedrules-calls-per-interval clj/s macro

(get-max-getmatchedrules-calls-per-interval)

The number of times getMatchedRules can be called within a period of GETMATCHEDRULES_QUOTA_INTERVAL.

https://developer.chrome.com/extensions/declarativeNetRequest#property-MAX_GETMATCHEDRULES_CALLS_PER_INTERVAL.

get-max-number-of-dynamic-rules clj/s macro

(get-max-number-of-dynamic-rules)

The maximum number of dynamic rules that an extension can add.

https://developer.chrome.com/extensions/declarativeNetRequest#property-MAX_NUMBER_OF_DYNAMIC_RULES.

get-max-number-of-rules clj/s macro

(get-max-number-of-rules)

The maximum number of rules that an extension can specify in the rule resources file. Any excess rules will be ignored and an install warning will be raised.

https://developer.chrome.com/extensions/declarativeNetRequest#property-MAX_NUMBER_OF_RULES.

getmatchedrules-quota-interval* cljs

(getmatchedrules-quota-interval* config)

max-getmatchedrules-calls-per-interval* cljs

(max-getmatchedrules-calls-per-interval* config)

max-number-of-dynamic-rules* cljs

(max-number-of-dynamic-rules* config)

max-number-of-rules* cljs

(max-number-of-rules* config)

on-rule-matched-debug* cljs

(on-rule-matched-debug* config channel & args)

set-action-count-as-badge-text clj/s macro

(set-action-count-as-badge-text enable)

Sets whether to automatically badge extension's icon to the matched action count for a tab. This preference is persisted across sessions and is false by default.

|enable| - https://developer.chrome.com/extensions/declarativeNetRequest#property-setActionCountAsBadgeText-enable.

https://developer.chrome.com/extensions/declarativeNetRequest#method-setActionCountAsBadgeText.

set-action-count-as-badge-text* cljs

(set-action-count-as-badge-text* config enable)

tap-all-events clj/s macro

(tap-all-events chan)

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

tap-on-rule-matched-debug-events clj/s macro

(tap-on-rule-matched-debug-events channel & args)

Fired when a rule is matched with a request. Only available for unpacked extensions with the declarativeNetRequestFeedback permission as this is intended to be used for debugging purposes only.

Events will be put on the |channel| with signature [::on-rule-matched-debug [matched-rule-info]] where:

|matched-rule-info| - The rule that has been matched along with information about the associated request.

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

https://developer.chrome.com/extensions/declarativeNetRequest#event-onRuleMatchedDebug.

update-dynamic-rules clj/s macro

(update-dynamic-rules rule-ids-to-remove rules-to-add)

Modify the current set of dynamic rules for the extension. The rules with IDs listed in rule_ids_to_remove are first removed, and then the rules given in rules_to_add are added. This update happens as a single atomic operation: either all specified rules are added and removed, or an error is returned. These rules are persisted across browser sessions. Any ids in rule_ids_to_remove that are not present will be ignored. Note that static rules specified as part of the extension package can not be removed using this function. Note: MAX_NUMBER_OF_DYNAMIC_RULES is the maximum number of dynamic rules an extension can add.

|rule-ids-to-remove| - The IDs of rules to remove. |rules-to-add| - The rules to add.

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/declarativeNetRequest#method-updateDynamicRules.

update-dynamic-rules* cljs

(update-dynamic-rules* config rule-ids-to-remove rules-to-add)