declarativeNetRequest.onRuleMatchedDebug
Fired when a rule is matched with a request. Only available extensions with the "declarativeNetRequestFeedback" permission, as this is intended for debugging purposes only. See Testing for details on how testing is enabled in each browser.
Syntax
browser.declarativeNetRequest.onRuleMatchedDebug.addListener(listener)
browser.declarativeNetRequest.onRuleMatchedDebug.removeListener(listener)
browser.declarativeNetRequest.onRuleMatchedDebug.hasListener(listener)
Events have three functions:
addListener(listener)-
Adds a listener to this event.
removeListener(listener)-
Stop listening to this event. The
listenerargument is the listener to remove. hasListener(listener)-
Check whether
listeneris registered for this event. Returnstrueif it is listening,falseotherwise.
addListener syntax
Parameters
listener-
The function called when this event occurs. The function is passed these arguments:
request-
An object containing information about the request the rule matched.
documentIdOptional-
A
string. The unique identifier for the frame's document, if this request is for a frame. documentLifecycleOptional-
A
string. The lifecycle of the frame's document, if this request is for a frame. Possible values are:"prerender","active","cached", or"pending_deletion". frameId-
A
number. The value0indicates that the request happens in the main frame. A positive value indicates the ID of a subframe where the request happens. If the document of a (sub-)frame is loaded (type ismain_frameorsub_frame),frameIdindicates this frame's ID, not the outer frame's ID. Frame IDs are unique within a tab. frameTypeOptional-
A
string. The type of the frame, if this request is for a frame. Possible values are:"outermost_frame","fenced_frame", or"sub_frame". initiatorOptional-
A
string. The origin where the request was initiated. This does not change through redirects. The string 'null' is used if this is an opaque origin. method-
A
string. A standard HTTP method. parentDocumentIdOptional-
A
string. The unique identifier for the frame's parent document, if this request is for a frame and has a parent. parentFrameId-
A
number. The ID of the frame that wraps the frame which sent the request. Set to-1if there is no parent frame. requestId-
A
string. The ID of the request. Request IDs are unique within a browser session. tabId-
A
number. The ID of the tab in which the request takes place. Set to-1if the request is not related to a tab. type-
ResourceType. The resource type of the request. url-
A
string. The URL of the request.
rule-
MatchedRule. Details of a matched rule.
Browser compatibility
| desktop | mobile | ||||||
|---|---|---|---|---|---|---|---|
onRuleMatchedDebug
|
|
|
|
|
|
|
|
request
|
|
|
|
|
|
|
|
request.documentId
|
|
|
|
|
|
|
|
request.documentLifecycle
|
|
|
|
|
|
|
|
request.frameId
|
|
|
|
|
|
|
|
request.frameType
|
|
|
|
|
|
|
|
request.initiator
|
|
|
|
|
|
|
|
request.method
|
|
|
|
|
|
|
|
request.parentDocumentId
|
|
|
|
|
|
|
|
request.parentFrameId
|
|
|
|
|
|
|
|
request.requestId
|
|
|
|
|
|
|
|
request.tabId
|
|
|
|
|
|
|
|
request.type
|
|
|
|
|
|
|
|
request.url
|
|
|
|
|
|
|
|
Legend
Tip: you can click/tap on a cell for more information.
- Full support
- Full support
- No support
- No support
- See implementation notes.