chrome.extension

說明

chrome.extension API 提供可供任何擴充功能頁面使用的公用程式。這項功能可支援在擴充功能與其內容指令碼之間,或在擴充功能之間交換訊息,詳情請參閱「訊息傳遞」一文。

類型

ViewType

Chrome 44 以上版本

擴充功能檢視畫面的類型。

列舉

"tab"

"popup"

屬性

inIncognitoContext

對於在無痕分頁中執行的內容指令碼,以及在無痕處理程序中執行的擴充功能頁面,此值為 True。後者僅適用於使用「split」incognito_behavior 的擴充功能。

類型

布林值

方法

getBackgroundPage()

僅限前景
chrome.extension.getBackgroundPage()

針對目前擴充功能中執行的背景頁面,傳回 JavaScript 的「window」物件。如果擴充功能沒有背景頁面,則會傳回空值。

傳回

  • Window | undefined

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

    承諾在資訊清單 3 以上版本中受支援,但回呼則是為了回溯相容性而提供。您無法在同一個函式呼叫中同時使用這兩種方法。承諾會以傳遞至回呼的相同類型解析。

isAllowedIncognitoAccess()

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

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

參數

  • 回呼

    函式 選填

    callback 參數如下所示:

    (isAllowedAccess: boolean) => void

    • isAllowedAccess

      布林值

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

傳回

  • Promise<布林值>

    Chrome 99 以上版本

    承諾在資訊清單 3 以上版本中受支援,但回呼則是為了回溯相容性而提供。您無法在同一個函式呼叫中同時使用這兩種方法。承諾會以傳遞至回呼的相同類型解析。

setUpdateUrlData()

chrome.extension.setUpdateUrlData(
  data: string,
)

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

參數

  • 資料

    字串

活動