chrome.extension

refresh date: 2026-09-25 robots: noindex

说明

chrome.extension API 具有可供任何扩展程序页面使用的实用程序。它支持在扩展程序与其内容脚本之间或扩展程序之间交换消息，如消息传递中所详述。

类型

ViewType

Chrome 44 及更高版本

扩展程序视图的类型。

枚举

"tab"

"popup"

属性

inIncognitoContext

对于在无痕式标签页中运行的内容脚本，以及在无痕式进程中运行的扩展程序页面，此值为 true。后者仅适用于 incognito_behavior 为“split”的扩展程序。

类型

布尔值

lastError

≤ MV2 自 Chrome 58 起已废弃

请使用 runtime.lastError。

如果异步扩展程序 API 导致错误，则在回调的生命周期内设置。如果未发生任何错误，lastError 将为 undefined。

类型

对象

属性

  • 私信

    字符串

    对已发生错误的描述。

方法

getBackgroundPage()

仅限前台 
chrome.extension.getBackgroundPage(): Window | undefined

返回当前扩展程序中运行的后台网页的 JavaScript“window”对象。如果扩展程序没有后台页面，则返回 null。

返回

  • Window | undefined

getExtensionTabs()

≤ MV2 仅限前台 已弃用
chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

请使用 extension.getViews {type: "tab"}。

返回一个数组，其中包含当前扩展程序中运行的每个标签页的 JavaScript“window”对象。如果指定了 windowId，则仅返回附加到指定窗口的标签页的“窗口”对象。

参数

  • windowId

    number 可选

返回

  • Window[]

    全局窗口对象数组

getURL()

≤ MV2 自 Chrome 58 起已废弃
chrome.extension.getURL(
  path: string,
): string

请使用 runtime.getURL。

将扩展程序安装目录中的相对路径转换为完全限定网址。

参数

  • 路径

    字符串

    扩展程序中资源的路径，相对于其安装目录表示。

返回

  • 字符串

    资源的完全限定网址。

getViews()

仅限前台 
chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

返回一个数组，其中包含当前扩展程序中运行的每个页面的 JavaScript“window”对象。

参数

  • fetchProperties

    对象（可选）

    • tabId

      number 可选

      Chrome 54 及更高版本

      根据标签页 ID 查找视图。如果省略此字段，则会返回所有视图。

    • 类型

      ViewType 可选

      要获取的视图类型。如果省略，则返回所有视图（包括后台网页和标签页）。

    • windowId

      number 可选

      要将搜索范围限制在其中的窗口。如果省略，则返回所有视图。

返回

  • Window[]

    全局对象数组

isAllowedFileSchemeAccess()

Promise 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
): Promise<boolean>

检索扩展程序对“file://”架构的访问状态。此政策对应的是用户控制的“允许访问文件网址”设置，该设置针对每个扩展程序，可通过 chrome://extensions 页面访问。

参数

  • callback

    函数可选

    callback 参数如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布尔值

      如果扩展程序可以访问“file://”架构，则为 true；否则为 false。

返回

  • Promise<boolean>

    Chrome 99 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

isAllowedIncognitoAccess()

Promise 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
): Promise<boolean>

检索扩展程序对无痕模式的访问状态。这对应于用户控制的、可通过 chrome://extensions 页面访问的每个扩展程序的“在无痕模式下启用”设置。

参数

  • callback

    函数可选

    callback 参数如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布尔值

      如果扩展程序有权访问无痕模式，则为 true，否则为 false。

返回

  • Promise<boolean>

    Chrome 99 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

sendRequest()

Promise &leq; MV2 已弃用
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
): Promise<any>

请使用 runtime.sendMessage。

向扩展程序中的其他监听器发送单个请求。与 runtime.connect 类似，但仅发送一个请求，并可选择是否返回响应。extension.onRequest 事件会在扩展程序的每个页面中触发。

参数

  • extensionId

    字符串 可选

    您要连接的扩展程序的 ID。如果省略，则默认值为您自己的扩展程序。

  • request

    任意

  • callback

    函数可选

    Chrome 99 及更高版本

    callback 参数如下所示： 

    (response: any) => void

    • Response

      任意

      请求处理程序发送的 JSON 响应对象。如果连接到扩展程序时出错，promise 将被拒绝。

返回

  • 承诺<任何>

    Chrome 99 及更高版本

    只有 Manifest V3 及更高版本支持 Promise，其他平台需要使用回调。

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
): void

设置扩展程序更新网址中使用的 ap CGI 参数的值。对于托管在 Chrome 扩展程序库中的扩展程序，此值会被忽略。

参数

  • 数据

    字符串

事件

onRequest

&leq; MV2 已弃用
chrome.extension.onRequest.addListener(
  callback: function,
)

请使用 runtime.onMessage。

当请求从扩展程序进程或内容脚本发送时触发。

参数

  • callback

    函数

    callback 参数如下所示： 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      任意

    • sendResponse

      函数

      sendResponse 参数如下所示： 

      () => void

onRequestExternal

&leq; MV2 已弃用
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

请使用 runtime.onMessageExternal。

当另一个扩展程序发送请求时触发。

参数

  • callback

    函数

    callback 参数如下所示： 

    (request: any, sender: runtime.MessageSender, sendResponse: function) => void

    • request

      任意

    • sendResponse

      函数

      sendResponse 参数如下所示： 

      () => void