chrome.declarativeWebRequest

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: AddRequestCookie) => {...}

  • 参数

    AddRequestCookie

  • 返回

    AddRequestCookie

• 饼干

  RequestCookie

  要添加到请求的 Cookie。没有可以未定义的字段。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: AddResponseCookie) => {...}

  • 参数

    AddResponseCookie

  • 返回

    AddResponseCookie

• 饼干

  ResponseCookie

  要添加到响应的 Cookie。必须指定名称和值。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: AddResponseHeader) => {...}

  • 参数

    AddResponseHeader

  • 返回

    AddResponseHeader

• name

  字符串

  HTTP 响应标头名称。

• 值

  字符串

  HTTP 响应标头值。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: CancelRequest) => {...}

  • 参数

    CancelRequest

  • 返回

    CancelRequest

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: EditRequestCookie) => {...}

  • 参数

    EditRequestCookie

  • 返回

    EditRequestCookie

• filter

  RequestCookie

  过滤出要修改的 Cookie。所有空条目都会被忽略。

• 修改

  RequestCookie

  应在构建过滤器的 Cookie 中覆盖的属性。设置为空字符串的属性会被移除。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: EditResponseCookie) => {...}

  • 参数

    EditResponseCookie

  • 返回

    EditResponseCookie

• filter

  FilterResponseCookie

  过滤出要修改的 Cookie。所有空条目都会被忽略。

• 修改

  ResponseCookie

  应在构建过滤器的 Cookie 中覆盖的属性。设置为空字符串的属性会被移除。

属性

• ageLowerBound

  编号（选填）

  包含 Cookie 生命周期下限（指定在当前时间之后的秒数内）。仅限失效日期时间设置为“now + ageLowerBound”的 Cookie或之后满足此条件。会话 Cookie 不符合此过滤器的条件。Cookie 生命周期通过“max-age”或“expires”Cookie 属性。如果两个都指定了，则为“max-age”计算 Cookie 生命周期。

• ageUpperBound

  编号（选填）

  包含 Cookie 生命周期的上限（以当前时间之后的秒数指定）。只有失效日期在 [now, now + ageUpperBound] 这一间隔内的 Cookie 才符合此条件。会话 Cookie 和有效期为过去时间的 Cookie 不符合此过滤器的条件。Cookie 生命周期通过“max-age”或“expires”Cookie 属性。如果两个都指定了，则为“max-age”计算 Cookie 生命周期。

• 网域

  字符串（可选）

  网域 Cookie 属性的值。

• expires

  字符串（可选）

  到期 Cookie 属性的值。

• httpOnly

  字符串（可选）

  是否存在 HttpOnly Cookie 属性。

• maxAge

  编号（选填）

  Max-Age Cookie 属性的值

• name

  字符串（可选）

  Cookie 的名称。

• 路径

  字符串（可选）

  路径 Cookie 属性的值。

• 安全

  字符串（可选）

  安全 Cookie 属性是否存在。

• 会话 Cookie

  布尔值（可选）

  过滤会话 Cookie。会话 Cookie 在任一“max-age”中未指定生命周期或“expires”属性。

• 值

  字符串（可选）

  Cookie 的值，可以用英文双引号填充。

属性

• nameContains

  string |string[] 选填

  如果标头名称包含所有指定字符串，则匹配。

• nameEquals

  字符串（可选）

  如果标头名称等于指定字符串，则匹配。

• 名称前缀

  字符串（可选）

  如果标头名称以指定字符串开头，则匹配。

• nameSuffix

  字符串（可选）

  如果标头名称以指定字符串结尾，则匹配。

• valueContains

  string |string[] 选填

  如果标头值包含所有指定字符串，则匹配。

• valueEquals

  字符串（可选）

  如果标头值等于指定字符串，则匹配。

• valuePrefix

  字符串（可选）

  如果标头值以指定字符串开头，则匹配。

• valueSuffix

  字符串（可选）

  如果标头值以指定字符串结尾，则匹配。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: IgnoreRules) => {...}

  • 参数

    IgnoreRules

  • 返回

    IgnoreRules

• hasTag

  字符串（可选）

  如果设置，系统会忽略具有指定标记的规则。这种忽略不会持久存在，它只影响同一网络请求阶段的规则及其操作。请注意，规则按其优先级的降序执行。此操作会影响优先级低于当前规则的规则。相同优先级的规则不一定会被忽略。

• lowerPriorityThan

  编号（选填）

  如果设置，系统会忽略优先级低于指定值的规则。此边界不会持久保留，它只影响同一网络请求阶段的规则及其操作。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RedirectByRegEx) => {...}

  • 参数

    RedirectByRegEx

  • 返回

    RedirectByRegEx

• 来自

  字符串

  可能包含捕获组的匹配模式。捕获组使用 Perl 语法（$1、$2, ...）而不是 RE2 语法（\1、\2...）引用，以便更接近 JavaScript 正则表达式。

• 至

  字符串

  目标格式。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RedirectRequest) => {...}

  • 参数

    RedirectRequest

  • 返回

    RedirectRequest

• redirectUrl

  字符串

  请求被重定向到的目标页面。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RedirectToEmptyDocument) => {...}

  • 参数

    RedirectToEmptyDocument

  • 返回

    RedirectToEmptyDocument

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RedirectToTransparentImage) => {...}

  • 参数

    RedirectToTransparentImage

  • 返回

    RedirectToTransparentImage

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RemoveRequestCookie) => {...}

  • 参数

    RemoveRequestCookie

  • 返回

    RemoveRequestCookie

• filter

  RequestCookie

  过滤出将被移除的 Cookie。所有空条目都会被忽略。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RemoveRequestHeader) => {...}

  • 参数

    RemoveRequestHeader

  • 返回

    RemoveRequestHeader

• name

  字符串

  HTTP 请求标头名称（不区分大小写）。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RemoveResponseCookie) => {...}

  • 参数

    RemoveResponseCookie

  • 返回

    RemoveResponseCookie

• filter

  FilterResponseCookie

  过滤出将被移除的 Cookie。所有空条目都会被忽略。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RemoveResponseHeader) => {...}

  • 参数

    RemoveResponseHeader

  • 返回

    RemoveResponseHeader

• name

  字符串

  HTTP 请求标头名称（不区分大小写）。

• 值

  字符串（可选）

  HTTP 请求标头值（不区分大小写）。

属性

• name

  字符串（可选）

  Cookie 的名称。

• 值

  字符串（可选）

  Cookie 的值，可以用英文双引号填充。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: RequestMatcher) => {...}

  • 参数

    RequestMatcher

  • 返回

    RequestMatcher

• contentType

  string[] 选填

  如果响应的 MIME 媒体类型（来自 HTTP Content-Type 标头）包含在列表中，则匹配。

• excludeContentType

  string[] 选填

  如果响应的 MIME 媒体类型（来自 HTTP Content-Type 标头）未包含在列表中，则匹配。

• excludeRequestHeaders

  HeaderFilter[] 可选

  如果没有任何请求标头与任何 HeaderFilters 匹配，则匹配。

• excludeResponseHeaders

  HeaderFilter[] 可选

  如果没有任何响应标头与任何 HeaderFilters 匹配，则匹配。

• firstPartyForCookiesUrl

  UrlFilter 可选

  <ph type="x-smartling-placeholder"></ph> 已弃用

  自版本 82 起已忽略。

  如果“第一方”满足 UrlFilter 的条件，则匹配请求的网址。“第一方”请求的网址（如果存在）可以与请求的目标网址不同，并说明什么是“第一方”以便进行第三方 Cookie 检查。

• requestHeaders

  HeaderFilter[] 可选

  如果某些请求标头与其中一个 HeaderFilters 匹配，则匹配。

• resourceType

  ResourceType[] 选填

  如果请求的请求类型包含在列表中，则匹配。与任何类型均不匹配的请求将被滤除。

• responseHeaders

  HeaderFilter[] 可选

  如果某些响应标头与其中一个 HeaderFilters 匹配，则匹配。

• 阶段

  Stage[]（可选）

  包含描述阶段的字符串列表。允许的值为“onBeforeRequest”、“onBeforeSendHeaders”、“onHeadersReceived”、“onAuthRequired”。如果此属性存在，则其适用阶段仅局限于所列阶段。请注意，整个条件仅适用于与所有属性都兼容的阶段。

• thirdPartyForCookies

  布尔值（可选）

  <ph type="x-smartling-placeholder"></ph> 已弃用

  自版本 87 起已忽略。

  如果设置为 true，则匹配受第三方 Cookie 政策约束的请求。如果设置为 false，匹配所有其他请求。

• 网址

  UrlFilter 可选

  如果请求的网址满足 UrlFilter 的条件，则匹配。

属性

• 网域

  字符串（可选）

  网域 Cookie 属性的值。

• expires

  字符串（可选）

  到期 Cookie 属性的值。

• httpOnly

  字符串（可选）

  是否存在 HttpOnly Cookie 属性。

• maxAge

  编号（选填）

  Max-Age Cookie 属性的值

• name

  字符串（可选）

  Cookie 的名称。

• 路径

  字符串（可选）

  路径 Cookie 属性的值。

• 安全

  字符串（可选）

  安全 Cookie 属性是否存在。

• 值

  字符串（可选）

  Cookie 的值，可以用英文双引号填充。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: SendMessageToExtension) => {...}

  • 参数

    SendMessageToExtension

  • 返回

    SendMessageToExtension

• 消息

  字符串

  系统将在传递给事件处理脚本的字典的 message 属性中传递该值。

属性

• 构造函数

  void

  constructor 函数如下所示：

  (arg: SetRequestHeader) => {...}

  • 参数

    SetRequestHeader

  • 返回

    SetRequestHeader

• name

  字符串

  HTTP 请求标头名称。

• 值

  字符串

  HTTP 请求标头值。

枚举

参数

• callback

  函数

  callback 参数如下所示：

  (details: object) => void

  • 详细信息

    对象

    • documentId

      字符串（可选）

      发出请求的文档的 UUID。

    • documentLifecycle

      extensionTypes.DocumentLifecycle

      文档所处的生命周期。

    • frameId

      number

      值 0 表示请求发生在主帧中；正值表示请求发生所在的子帧的 ID。如果（子）帧的文档已加载（type 为 main_frame 或 sub_frame），则 frameId 表示此帧的 ID，而不是外帧的 ID。帧 ID 在标签页中是唯一的。

    • frameType

      extensionTypes.FrameType

      导航发生的帧类型。

    • 消息

      字符串

      由调用脚本发送的消息。

    • method

      字符串

      标准 HTTP 方法。

    • parentDocumentId

      字符串（可选）

      拥有此框架的父文档的 UUID。如果没有父级，则不会设置此字段。

    • parentFrameId

      number

      封装发送请求的帧的帧的 ID。如果不存在父帧，则设置为 -1。

    • requestId

      字符串

      请求的 ID。请求 ID 在浏览器会话中是唯一的。因此，它们可用于将同一请求的不同事件相关联。

    • 流程中的

      阶段

      事件触发的网络请求阶段。

    • tabId

      number

      发生请求的标签页的 ID。如果请求与标签页无关，请将其设为 -1。

    • timeStamp

      number

      触发此信号的时间（以毫秒为单位，从 Epoch 起算）。

    • 类型

      webRequest.ResourceType

      请求的资源将如何使用。

    • 网址

      字符串

条件

操作