chrome.extension

Description

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

Summary

Types

ViewType

Chrome 44+

扩展视图的类型。

TYPE

"tab", or "popup"

Properties

inIncognitoContext

对于在隐身选项卡内运行的内容脚本,以及在隐身进程内运行的扩展页面,都是如此。后者仅适用于具有 'split' incognito_behavior 的扩展。

TYPE

boolean

lastError

≤MV2 Deprecated since Chrome 58

Please use runtime.lastError.

如果异步扩展 api 导致错误,则设置回调的生命周期。如果没有发生错误,lastError 将是未定义的undefined

TYPE

object

PROPERTIES

  • message

    string

    发生的错误的描述。

Methods

getBackgroundPage

chrome.extension.getBackgroundPage()

Foreground only

返回在当前扩展中运行的后台页面的 JavaScript 'window' 对象。如果扩展没有背景页面,则返回 null。

RETURNS

  • Window | undefined

getExtensionTabs

chrome.extension.getExtensionTabs(
  windowId?: number,
)

≤MV2 Foreground only Deprecated

Please use extension.getViews {type: "tab"}.

为当前扩展中运行的每个选项卡返回 JavaScript 'window' 对象数组。如果指定了 windowId,则仅返回附加到指定窗口的选项卡的 'window' 对象。

PARAMETERS

  • windowId

    number optional

RETURNS

  • Window[]

    全局窗口对象数组

getURL

chrome.extension.getURL(
  path: string,
)

≤MV2 Deprecated since Chrome 58

Please use runtime.getURL.

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

PARAMETERS

  • path

    string

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

RETURNS

  • string

    资源的完全限定 URL。

getViews

chrome.extension.getViews(
  fetchProperties?: object,
)

Foreground only

为当前扩展中运行的每个页面返回 JavaScript 'window' 对象数组。

PARAMETERS

  • fetchProperties

    object optional

    • tabId

      number optional

      Chrome 54+

      根据选项卡 ID 查找视图。如果省略此字段,则返回所有视图。

    • type

      ViewType optional

      要获取的视图类型。如果省略,则返回所有视图(包括背景页面和选项卡)。有效值:“tab”、“notification”、“popup”。

    • windowId

      number optional

      限制搜索的窗口。如果省略,则返回所有视图。

RETURNS

  • Window[]

    全局对象数组

isAllowedFileSchemeAccess

chrome.extension.isAllowedFileSchemeAccess(
  callback: function,
)

检索扩展对“file://”方案scheme的访问状态。这对应于用户控制的每个扩展的“允许访问文件 URL”设置,可通过 chrome://extensions 页面访问。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    (isAllowedAccess: boolean) => void
    • isAllowedAccess

      boolean

      如果扩展程序可以访问“file://”方案,则为true,否则为false。

isAllowedIncognitoAccess

chrome.extension.isAllowedIncognitoAccess(
  callback: function,
)

检索扩展程序访问隐身模式的状态。这对应于可通过 chrome://extensions 页面访问的用户控制的每个扩展的“隐身允许(Allowed in Incognito)”设置。

PARAMETERS

  • callback

    function

    The callback parameter looks like:

    (isAllowedAccess: boolean) => void
    • isAllowedAccess

      boolean

      如果扩展程序可以访问隐身模式,则为 true,否则为 false。

sendRequest

chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  responseCallback?: function,
)

≤MV2 Deprecated

Please use runtime.sendMessage.

向扩展中的其他侦听器发送单个请求。与 runtime.connect 类似,但只发送一个带有可选响应的请求。在扩展的每个页面中都会触发 extension.onRequest 事件。

PARAMETERS

  • extensionId

    string optional

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

  • request

    any

  • responseCallback

    function optional

    The responseCallback parameter looks like:

    (response: any) => void
    • response

      any

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

setUpdateUrlData

chrome.extension.setUpdateUrlData(
  data: string,
)

设置扩展程序更新 URL 中使用的 ap CGI 参数的值。对于托管在 Chrome 扩展程序库中的扩展程序,将忽略此值。

PARAMETERS

  • data

    string

Events

onRequest

chrome.extension.onRequest.addListener(
  callback: function,
)

≤MV2 Deprecated

Please use runtime.onMessage.

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

PARAMETERS

  • callback

    function

    The callback parameter looks like:

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

    • request

      any

    • sender

      runtime.MessageSender

    • sendResponse

      function

      The sendResponse parameter looks like:

      () => void

onRequestExternal

chrome.extension.onRequestExternal.addListener(
  callback: function,
)

≤MV2 Deprecated

Please use runtime.onMessageExternal.

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

PARAMETERS

  • callback

    function

    The callback parameter looks like:

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

    • request

      any

    • sender

      runtime.MessageSender

    • sendResponse

      function

      The sendResponse parameter looks like:

      () => void

By.一粒技术服务.

results matching ""

    No results matching ""