webRequest.BlockingResponse

An object of this type is returned by event listeners that have set "blocking" in their extraInfoSpec 自变量。

By setting particular properties in BlockingResponse , the listener can modify network requests.

Note that you can't set all this object's properties in every listener: the properties you can set are dependent on the event that triggered this listener, as detailed below.

类型

Values of this type are objects. They contain the following properties:

authCredentials 可选

对象 . If set, the request is made using the given credentials. You can only set this property in  onAuthRequired authCredentials property is an object with the following properties:

username

string . Username to supply.

password

string . Password to supply.

cancel 可选

boolean 。若 true , the request is cancelled. You can only set this property in onBeforeRequest , onBeforeSendHeaders , onHeadersReceived ,和 onAuthRequired .

redirectUrl 可选

string . This is a URL, and if set, the original request is redirected to that URL. You can only set this property in onBeforeRequest or onHeadersReceived .

Redirections to non-HTTP schemes such as data: are allowed, but they are not currently supported ( bug 707624 ). Redirects use the same request method as the original request unless initiated from onHeadersReceived stage, in which case the redirect uses the GET method.

If an extension wants to redirect a public (e.g. HTTPS) URL to an extension page , the extension's manifest.json file must contain a web_accessible_resources key that lists the URL for the extension page..

requestHeaders 可选

webRequest.HttpHeaders . This is an HttpHeaders object, an array in which each object represents a header. If set, the request is made with these headers rather than the original headers. You can only set this property in  onBeforeSendHeaders .

responseHeaders 可选

webRequest.HttpHeaders . This is an HttpHeaders object, an array in which each object represents a header. If set, the server is assumed to have responded with these response headers instead of the originals. You can only set this property in  onHeadersReceived . If multiple extensions attempt to set the same header (for example, Content-Security-Policy ), only one of the changes will be successful.

upgradeToSecure 可选

boolean 。若设为 true and the original request is an HTTP request, this will prevent the original request from being sent and instead make a secure (HTTPS) request. If any extension returns redirectUrl in onBeforeRequest ,那么 upgradeToSecure will be ignored for that request. You can only set this property in onBeforeRequest .

浏览器兼容性

BCD tables only load in the browser

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

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