本頁面由 Cloud Translation API 翻譯而成。

chrome.extension

說明

chrome.extension API 提供的公用程式可供任何擴充功能頁面使用。包括支援在擴充功能和內容指令碼之間，或是在擴充功能之間交換訊息，詳情請參閱「訊息傳遞」。

類型

ViewType

Chrome 44 以上版本

擴充功能檢視畫面類型。

列舉

「tab」

「popup」

屬性

inIncognitoContext

如果內容指令碼在無痕分頁中執行，或擴充功能網頁在無痕程序中執行，則為 True。後者僅適用於具有「split」incognito_behavior 的擴充功能。

類型

布林值

lastError

&leq; MV2 Chrome 58 版起已淘汰

請使用 runtime.lastError。

如果非同步擴充功能 API 發生錯誤，請為回呼的生命週期設定此值。如果沒有發生任何錯誤，lastError 會是 undefined。

類型

物件

屬性

訊息

字串

說明發生的錯誤。

方法

getBackgroundPage()

僅限前景

chrome.extension.getBackgroundPage(): Window | undefined

傳回在目前擴充功能中執行的背景網頁 JavaScript「window」物件。如果擴充功能沒有背景網頁，則傳回空值。

傳回

Window | undefined

getExtensionTabs()

&leq; MV2 僅限前景已淘汰

chrome.extension.getExtensionTabs(
  windowId?: number,
): Window[]

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

傳回 JavaScript「window」物件的陣列，適用於目前擴充功能中執行的每個分頁。如果指定 windowId，則只會傳回附加至指定視窗的分頁「視窗」物件。

參數

windowId

號碼選填

傳回

Window[]

全域視窗物件陣列

getURL()

&leq; MV2 Chrome 58 版起已淘汰

chrome.extension.getURL(
  path: string,
): string

請使用 runtime.getURL。

將擴充功能安裝目錄中的相對路徑轉換為完整網址。

參數

路徑

字串

擴充功能內資源的路徑，以安裝目錄的相對路徑表示。

傳回

字串

資源的完整網址。

getViews()

僅限前景

chrome.extension.getViews(
  fetchProperties?: object,
): Window[]

傳回 JavaScript「window」物件的陣列，適用於目前擴充功能中執行的每個網頁。

參數

fetchProperties

object 選填
- tabId
  
  號碼選填
  
  Chrome 54 以上版本
  
  根據分頁 ID 尋找檢視畫面。如果省略這個欄位，系統會傳回所有檢視區塊。
- 類型
  
  ViewType 選填
  
  要取得的檢視畫面類型。如果省略，則會傳回所有檢視區塊 (包括背景網頁和分頁)。
- windowId
  
  號碼選填
  
  要限制搜尋範圍的視窗。如果省略，則會傳回所有檢視區塊。

傳回

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 以上版本

只有資訊清單 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 以上版本

只有資訊清單 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。如果省略，預設為您自己的擴充功能。
申請。

不限
callback

函式選用

Chrome 99 以上版本

callback 參數如下：
```
(response: any) => void
```
- 回應
  
  不限
  
  要求處理常式傳送的 JSON 回應物件。如果連線至擴充功能時發生錯誤，系統會呼叫回呼，但不含任何引數，且 runtime.lastError 會設為錯誤訊息。

傳回

Promise<any>

Chrome 99 以上版本

只有資訊清單 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
```
- 申請。
  
  不限
- 寄件者
  
  runtime.MessageSender
- sendResponse
  
  函式
  
  sendResponse 參數如下：
```
() => void
```

onRequestExternal