webRequest.onErrorOccurred

Fired when a request could not be processed due to an error: for example, a lack of Internet connectivity.

The error is passed to the listener as the error 特性为 details 对象。

Note that this event is not fired for HTTP errors (4XX or 5XX responses): these will go through the normal stages of a request, calling any event listeners, and setting details.statusCode to report the error.

This event is informational only.

句法

browser.webRequest.onErrorOccurred.addListener(
  listener,             // function
  filter                //  object
)
browser.webRequest.onErrorOccurred.removeListener(listener)
browser.webRequest.onErrorOccurred.hasListener(listener)

					

Events have three functions:

addListener(callback, filter)

Adds a listener to this event.

removeListener(listener)

Stop listening to this event. The listener argument is the listener to remove.

hasListener(listener)

校验是否 listener is registered for this event. Returns true if it is listening, false 否则。

addListener syntax

参数

callback

A function that will be called when this event occurs. The function will be passed the following arguments:

details

对象 . Details about the request. See details 下文。

filter

webRequest.RequestFilter . A filter that restricts the events that will be sent to this listener.

Additional objects

details

cookieStoreId

string . If the request is from a tab open in a contextual identity, the cookie store ID of the contextual identity.

documentUrl

string . URL of the document in which the resource will be loaded. For example, if the web page at "https://example.com" contains an image or an iframe, then the documentUrl for the image or iframe will be "https://example.com". For a top-level document, documentUrl is undefined.

error

string . The error description. This string is an internal error string, may vary from one browser to another, and is not guaranteed to stay the same between releases.

frameId

integer . Zero if the request happens in the main frame; a positive value is the ID of a subframe in which the request happens. If the document of a (sub-)frame is loaded ( type is main_frame or sub_frame ), frameId indicates the ID of this frame, not the ID of the outer frame. Frame IDs are unique within a tab.

fromCache

boolean . Indicates if this response was fetched from disk cache.

incognito

boolean . Whether the request is from a private browsing window.

ip

string . The IP address of the server the request was sent to. It may be a literal IPv6 address.

方法

string . Standard HTTP method: for example, "GET" or "POST".

originUrl

string . URL of the resource which triggered the request. For example, if "https://example.com" contains a link, and the user clicks the link, then the originUrl for the resulting request is "https://example.com".

originUrl is often but not always the same as the documentUrl . For example, if a page contains an iframe, and the iframe contains a link that loads a new document into the iframe, then the documentUrl for the resulting request will be the iframe's parent document, but the originUrl will be the URL of the document in the iframe that contained the link.

parentFrameId

integer . ID of the frame that contains the frame which sent the request. Set to -1 if no parent frame exists.

proxyInfo

对象 . This property is present only if the request is being proxied. It contains the following properties:

host

string . The hostname of the proxy server.

port

integer . The port number of the proxy server.

type

string . The type of proxy server. One of:

  • "http": HTTP proxy (or SSL CONNECT for HTTPS)
  • "https": HTTP proxying over TLS connection to proxy
  • "socks": SOCKS v5 proxy
  • "socks4": SOCKS v4 proxy
  • "direct": no proxy
  • "unknown": unknown proxy
username

string . Username for the proxy service.

proxyDNS

boolean . True if the proxy will perform domain name resolution based on the hostname supplied, meaning that the client should not do its own DNS lookup.

failoverTimeout

integer . Failover timeout in seconds. If the proxy connection fails, the proxy will not be used again for this period.

requestId

string . The ID of the request. Request IDs are unique within a browser session, so you can use them to relate different events associated with the same request.

tabId

integer . The ID of the tab in which the request takes place. Set to -1 if the request isn't related to a tab.

thirdParty

boolean . Indicates whether the request and its content window hierarchy are third party.

timeStamp

编号 . The time when this event fired, in milliseconds since the epoch .

type

webRequest.ResourceType . The type of resource being requested: for example, "image", "script", "stylesheet".

url

string . Target of the request.

urlClassification

对象 . The type of tracking associated with the request, if with the request has been classified by Firefox Tracking Protection . This is an object with the following properties:

firstParty

array of strings . Classification flags for the request's first party.

thirdParty

array of strings . Classification flags for the request or its window hierarchy's third parties.

The classification flags include:

  • fingerprinting and fingerprinting_content : indicates the request is involved in fingerprinting. fingerprinting_content indicates the request is loaded from an origin that has been found to fingerprint but is not considered to participate in tracking, such as a payment provider.
  • cryptomining and cryptomining_content : similar to the fingerprinting category but for cryptomining resources.
  • tracking , tracking_ad , tracking_analytics , tracking_social ,  and tracking_content : indicates the request is involved in tracking. tracking is any generic tracking request, the ad , analytics , social ,和 content suffixes identify the type of tracker.
  • any_basic_tracking : a meta flag that combines any tracking and fingerprinting flags, excluding tracking_content and fingerprinting_content .
  • any_strict_tracking : a meta flag that combines any tracking and fingerprinting flags, including tracking_content and fingerprinting_content .
  • any_social_tracking : a meta flag that combines any social tracking flags.

浏览器兼容性

BCD tables only load in the browser

范例

var target = "<all_urls>";
/*
e.g., with no network:
"https://developer.mozilla.org/en-US/"
NS_ERROR_NET_ON_RESOLVED in Firefox
net::ERR_INTERNET_DISCONNECTED in Chrome
*/
function logError(responseDetails) {
  console.log(responseDetails.url);
  console.log(responseDetails.error);
}
browser.webRequest.onErrorOccurred.addListener(
  logError,
  {urls: [target]}
);

				

Example extensions

注意: This API is based on Chromium's chrome.webRequest API. This documentation is derived from web_request.json in the Chromium code.

Microsoft Edge compatibility data is supplied by Microsoft Corporation and is included here under the Creative Commons Attribution 3.0 United States License.

Found a problem with this page?

最后修改: , 由 MDN 贡献者

  1. 浏览器扩展名
  2. 快速入门
    1. What are extensions?
    2. Your first extension
    3. Your second extension
    4. Anatomy of an extension
    5. Example extensions
    6. What next?
  3. 概念
    1. Using the JavaScript APIs
    2. Content scripts
    3. Match patterns
    4. Working with files
    5. 国际化
    6. Content Security Policy
    7. Native messaging
    8. Differences between API implementations
    9. Chrome incompatibilities
  4. 用户界面
    1. 用户界面
    2. Toolbar button
    3. Address bar button
    4. Sidebars
    5. Context menu items
    6. Options page
    7. Extension pages
    8. Notifications
    9. Address bar suggestions
    10. Developer tools panels
  5. 如何
    1. Intercept HTTP requests
    2. Modify a web page
    3. Insert external content
    4. Share objects with page scripts
    5. Add a button to the toolbar
    6. Implement a settings page
    7. Work with the Tabs API
    8. Work with the Bookmarks API
    9. Work with the Cookies API
    10. Work with contextual identities
    11. Interact with the clipboard
    12. Build a cross-browser extension
  6. Firefox differentiators
  7. JavaScript API
    1. Browser support for JavaScript APIs
    2. alarms
    3. bookmarks
    4. browserAction
    5. browserSettings
    6. browsingData
    7. captivePortal
    8. clipboard
    9. 命令
    10. contentScripts
    11. contextualIdentities
    12. Cookie
    13. devtools
    14. dns
    15. downloads
    16. events
    17. extension
    18. extensionTypes
    19. find
    20. history
    21. i18n
    22. identity
    23. idle
    24. management
    25. menus
    26. notifications
    27. omnibox
    28. pageAction
    29. permissions
    30. pkcs11
    31. privacy
    32. proxy
    33. runtime
    34. search
    35. sessions
    36. sidebarAction
    37. storage
    38. tabs
    39. theme
    40. topSites
    41. 类型
    42. userScripts
    43. webNavigation
    44. webRequest
      1. 方法
        1. filterResponseData()
        2. getSecurityInfo()
        3. handlerBehaviorChanged()
      2. 特性
        1. MAX_HANDLER_BEHAVIOR_CHANGED_CALLS_PER_10_MINUTES
      3. 类型
        1. BlockingResponse
        2. CertificateInfo
        3. HttpHeaders
        4. RequestFilter
        5. ResourceType
        6. SecurityInfo
        7. StreamFilter
        8. UploadData
      4. 事件
        1. onAuthRequired
        2. onBeforeRedirect
        3. onBeforeRequest
        4. onBeforeSendHeaders
        5. onCompleted
        6. onErrorOccurred
        7. onHeadersReceived
        8. onResponseStarted
        9. onSendHeaders
    45. windows
  8. Manifest keys
    1. 介绍
    1. 作者
    2. background
    3. browser_action
    4. browser_specific_settings
    5. chrome_settings_overrides
    6. chrome_url_overrides
    7. 命令
    8. content_scripts
    9. content_security_policy
    10. default_locale
    11. description
    12. developer
    13. devtools_page
    14. dictionaries
    15. externally_connectable
    16. homepage_url
    17. icons
    18. incognito
    19. manifest_version
    20. name
    21. offline_enabled
    22. omnibox
    23. optional_permissions
    24. options_page
    25. options_ui
    26. page_action
    27. permissions
    28. protocol_handlers
    29. short_name
    30. sidebar_action
    31. storage
    32. theme
    33. theme_experiment
    34. user_scripts
    35. version
    36. version_name
    37. web_accessible_resources
  9. Extension Workshop
    1. Develop
    2. Publish
    3. Manage
    4. Enterprise
  10. Contact us
  11. Channels
    1. Add-ons blog
    2. Add-ons forum
    3. Add-ons chat