chrome.extension

说明

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

类型

ViewType

Chrome 44 及更高版本

扩展程序视图的类型。

枚举

"tab"

"popup"

属性

inIncognitoContext

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

类型

布尔值

lastError

小于等于 MV2 自 Chrome 58 起已废弃

请使用 runtime.lastError。

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

类型

对象

属性

  • 消息

    字符串

    对所发生错误的说明。

方法

getBackgroundPage()

仅限前台 
chrome.extension.getBackgroundPage()

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

返回

  • Window | undefined

getExtensionTabs()

小于等于 MV2 仅限前台 已废弃
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

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

参数

  • windowId

    number 可选

返回

  • Window[]

    全局窗口对象的数组

getURL()

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

请使用 runtime.getURL。

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

参数

  • 路径

    字符串

    相对于扩展程序安装目录的扩展程序内资源的路径。

返回

  • 字符串

    资源的完全限定网址。

getViews()

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

针对当前扩展程序中运行的每个网页返回 JavaScript“window”对象的数组。

参数

  • fetchProperties

    对象（可选）

    • tabId

      number 可选

      Chrome 54 及更高版本

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

    • 类型

      ViewType（可选）

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

    • windowId

      number 可选

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

返回

  • Window[]

    全局对象的数组

isAllowedFileSchemeAccess()

prometido 
chrome.extension.isAllowedFileSchemeAccess(
  callback?: function,
)

检索扩展程序对“file://”架构的访问权限状态。这与用户可通过 chrome://extensions 页面控制的各个扩展程序的“允许访问文件网址”设置相对应。

参数

  • callback

    函数（可选）

    callback 参数如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布尔值

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

返回

  • Promise<boolean>

    Chrome 99 及更高版本

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

isAllowedIncognitoAccess()

prometido 
chrome.extension.isAllowedIncognitoAccess(
  callback?: function,
)

检索扩展程序对无痕模式的访问权限状态。这与用户可通过 chrome://extensions 页面控制的各个扩展程序的“允许在无痕模式下运行”设置相对应。

参数

  • callback

    函数（可选）

    callback 参数如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布尔值

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

返回

  • Promise<boolean>

    Chrome 99 及更高版本

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

sendRequest()

Promise 小于等于 MV2 已废弃
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

请使用 runtime.sendMessage。

向扩展程序中的其他监听器发送单个请求。与 runtime.connect 类似，但只发送一个请求，且响应为可选。扩展程序的每个网页都会触发 extension.onRequest 事件。

参数

  • extensionId

    字符串（选填）

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

  • request

    任意

  • callback

    函数（可选）

    Chrome 99 及更高版本

    callback 参数如下所示： 

    (response: any) => void

    • Response

      任意

      请求处理脚本发送的 JSON 响应对象。如果在连接到扩展程序时发生错误，系统将调用不带参数的回调，并将 runtime.lastError 设置为错误消息。

返回

  • Promise<any>

    Chrome 99 及更高版本

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

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

参数

  • 数据

    字符串

事件

onRequest

小于等于 MV2 已废弃
chrome.extension.onRequest.addListener(
  callback: function,
)

请使用 runtime.onMessage。

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

参数

  • callback

    函数

    callback 参数如下所示： 

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

    • request

      任意

    • sendResponse

      函数

      sendResponse 参数如下所示： 

      () => void

onRequestExternal

小于等于 MV2 已废弃
chrome.extension.onRequestExternal.addListener(
  callback: function,
)

请使用 runtime.onMessageExternal。

当从其他扩展程序发送请求时触发。

参数

  • callback

    函数

    callback 参数如下所示： 

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

    • request

      任意

    • sendResponse

      函数

      sendResponse 参数如下所示： 

      () => void