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」物件。如果擴充功能沒有背景頁面，則會傳回空值。

傳回

  • Window | undefined

getExtensionTabs()

≤ MV2 僅限前景 已淘汰
chrome.extension.getExtensionTabs(
  windowId?: number,
)

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

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

參數

  • windowId

    號碼 選填

傳回

  • Window[]

    全域視窗物件陣列

getURL()

≤ MV2 自 Chrome 58 版起已淘汰
chrome.extension.getURL(
  path: string,
)

請使用 runtime.getURL。

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

參數

  • 路徑

    字串

    擴充功能中資源的路徑，相對於其安裝目錄。

傳回

  • 字串

    資源的完整網址。

getViews()

僅限前景 
chrome.extension.getViews(
  fetchProperties?: object,
)

針對目前擴充功能中執行的每個網頁，傳回 JavaScript 'window' 物件的陣列。

參數

  • fetchProperties

    物件 選填

    • tabId

      號碼 選填

      Chrome 54 以上版本

      根據分頁 ID 尋找檢視畫面。如果省略這個欄位，系統會傳回所有檢視畫面。

    • 類型

      ViewType 選填

      要取得的檢視類型。如果省略，則會傳回所有檢視畫面 (包括背景頁面和分頁)。

    • windowId

      號碼 選填

      要限制搜尋的視窗。如果省略，則會傳回所有檢視畫面。

傳回

  • Window[]

    全域物件的陣列

isAllowedFileSchemeAccess()

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

擷取擴充功能對「file://」配置的存取權狀態。這項設定對應至使用者可透過 chrome://extensions 頁面控制的每個擴充功能「允許存取檔案網址」設定。

參數

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布林值

      如果擴充功能可以存取「file://」配置，則傳回「是」；否則傳回「否」。

傳回

  • Promise<布林值>

    Chrome 99 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需使用回呼。

isAllowedIncognitoAccess()

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

擷取擴充功能對無痕模式存取權的狀態。這項設定對應至使用者可透過 chrome://extensions 頁面控制的「允許在無痕模式中執行」擴充功能設定。

參數

  • 回呼

    函式 選填

    callback 參數如下所示： 

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布林值

      如果擴充功能可存取無痕模式，則傳回「是」；否則傳回「否」。

傳回

  • Promise<布林值>

    Chrome 99 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需使用回呼。

sendRequest()

Promise &leq; MV2 已淘汰
chrome.extension.sendRequest(
  extensionId?: string,
  request: any,
  callback?: function,
)

請使用 runtime.sendMessage。

向擴充功能中的其他事件監聽器傳送單一要求。與 runtime.connect 類似，但只會傳送單一要求，並提供選用的回應。extension.onRequest 事件會在擴充功能的每個頁面中觸發。

參數

  • extensionId

    string 選填

    要連結的擴充功能 ID。如果省略，預設值為您自己的擴充功能。

  • 申請。

    不限

  • 回呼

    函式 選填

    Chrome 99 以上版本

    callback 參數如下所示： 

    (response: any) => void

    • 回應

      不限

      要求的處理常式傳送的 JSON 回應物件。如果在連線至擴充功能時發生錯誤，系統會呼叫回呼，但不帶引數，並將 runtime.lastError 設為錯誤訊息。

傳回

  • Promise<any>

    Chrome 99 以上版本

    承諾僅支援資訊清單 V3 以上版本，其他平台則需使用回呼。

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

設定擴充功能更新網址中使用的 ap CGI 參數值。如果擴充功能由 Chrome 擴充功能相簿代管，系統會忽略這個值。

參數

  • 資料

    字串

活動

onRequest

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

請使用 runtime.onMessage。

當擴充功能程序或內容指令碼傳送要求時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • 申請。

      不限

    • sendResponse

      函式

      sendResponse 參數如下所示： 

      () => void

onRequestExternal

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

請使用 runtime.onMessageExternal。

當其他擴充功能傳送要求時觸發。

參數

  • 回呼

    函式

    callback 參數如下所示： 

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

    • 申請。

      不限

    • sendResponse

      函式

      sendResponse 參數如下所示： 

      () => void