支援Microsoft Edge擴充功能的 API
Microsoft Edge 擴充功能會針對 Chromium 瀏覽器引擎平臺使用 JavaScript 方法的子集。 建置 Microsoft Edge 瀏覽器的擴充功能時,您可以使用下列 API。
API | 描述 | 指令清單版本 |
---|---|---|
accessibilityFeatures | 管理瀏覽器的輔助功能功能。 | MV2、MV3 |
action | 控制瀏覽器工具列中延伸模組的圖示。 | MV3 |
警報 | 排程程式代碼在未來的指定時間定期執行。 | MV2、MV3 |
書籤 | 建立、組織及操作書籤。 | MV2、MV3 |
browserAction | 使用瀏覽器動作在 Microsoft Edge 的工具列上放置圖示。 您也可以使用瀏覽器動作來新增工具提示、徽章或快顯。 | MV2 |
browsingData | 從使用者的本機配置檔移除瀏覽數據。 | MV2、MV3 |
命令 | 新增可在延伸模組中觸發動作的鍵盤快捷方式,例如開啟瀏覽器或將命令傳送至延伸模組的動作。 | MV2、MV3 |
contentSettings | 自定義每個網站上Microsoft Edge 的行為,而不是全域行為。 變更設定,控制網站是否可以使用 Cookie、JavaScript 和外掛程式等功能。 | MV2、MV3 |
contextMenus | 將專案新增至操作功能表, (在 Microsoft Edge 中以滑鼠右鍵按單) 。 功能表項可以套用至不同的物件,例如影像、超鏈接和頁面。 | MV2、MV3 |
餅乾 | 查詢和修改 Cookie,並在變更時接收通知。 | MV2、MV3 |
調試器 | 附加至一或多個索引標籤,以檢測網路互動、偵錯 JavaScript、變更 DOM、變更 CSS 等等。 使用 [偵錯專案tabId ] 來以 索引標籤為sendCommand 目標,並透過onEvent 回呼路tabId 由傳送事件。 |
MV2、MV3 |
declarativeContent | 根據頁面的內容執行動作,而不需要讀取頁面內容的許可權。 | MV2、MV3 |
declarativeNetRequest | 藉由指定宣告式規則來封鎖或修改網路要求,以提供更多隱私權。 允許擴充功能修改網路要求,而不需要攔截要求和檢視內容。 | MV2、MV3 |
desktopCapture | 擷取畫面、個別視窗或索引標籤的內容。 | MV2、MV3 |
devtools.inspectedWindow | 與檢查的窗口互動。 例如, 會取得頁面的索引標籤標識碼、重新整理頁面,或取得頁面上的資源。 | MV2、MV3 |
devtools.network | 擷取DevTools網路工具所顯示之 網路 要求的相關信息。 | MV2、MV3 |
devtools.panel | 藉由建立自己的面板、存取現有的面板,或新增提要字段,將延伸模組整合到開發人員工具視窗 UI 中。 | MV2、MV3 |
dns | 解析 DNS 位址。 | MV2、MV3。 開發人員通道。 |
dom | 存取適用於擴充功能的特殊 DOM API。 | MV2、MV3 |
下載 | 以程式設計方式啟動、監視、操作及搜尋下載。 | MV2、MV3 |
enterprise.hardwarePlatform | 取得執行瀏覽器之硬體平臺的製造商和型號。 適用於企業原則所安裝的擴充功能。 | MV2、MV3 |
事件 | API 所使用的常見類型,這些 API 會引發事件,以在發生有趣的事件時通知您。 | MV2、MV3 |
外延 | 任何擴充功能頁面都可以使用的公用程式。 包含在擴充功能與其內容腳本之間或擴充功能之間交換訊息的支援。 | MV2、MV3 |
extensionTypes | Microsoft Edge 延伸模組的類型宣告。 | MV2、MV3 |
fontSettings | 管理 Microsoft Edge 中的字型設定。 | MV2、MV3 |
歷史 | 與瀏覽器的瀏覽頁面記錄互動。 您可以在瀏覽器的歷程記錄中新增、移除或查詢URL。 若要使用您自己的版本覆寫歷程記錄頁面,請流覽至 [覆寫頁面]。 | MV2、MV3 |
i18n | 在整個應用程式或延伸模組中實作國際化。 | MV2、MV3 |
身份 | 取得 OAuth2 存取令牌。 不支援: identity.getAccounts、 identity.getAuthToken - 或者,您可以使用 identity.launchWebAuthFlow 來擷取 OAuth2 令牌來驗證使用者。 | MV2、MV3 |
怠 | 偵測機器的閑置狀態何時變更。 | MV2、MV3 |
input.ime | 實作OS的自定義IME,允許擴充功能處理按鍵、設定組合,以及管理候選視窗。 | MV2、MV3 |
管理 | 管理已安裝或執行中的擴充功能清單。 可以覆寫內建的 [新增索引卷標] 頁面。 | MV2、MV3 |
通知 | 使用範本建立豐富的通知,並將其顯示在系統匣中。 | MV2、MV3 |
offscreen | 建立和管理螢幕外檔。 | MV3 |
omnibox | 在 Microsoft Edge 網址列中註冊關鍵詞,也稱為 omnibox。 | MV2、MV3 |
pageAction | 將圖示新增至網址列右側的 Microsoft Edge 工具列。 頁面動作是可以在目前頁面上採取的動作,不適用於所有頁面。 當非使用中時,頁面動作會呈現灰色。 | MV2 |
pageCapture | 將索引標籤儲存為 MHTML 檔案。 | MV2、MV3 |
權限 | 在運行時間擷取已宣告的選擇性許可權,而不是在安裝時擷取。 您可以使用此 API 向使用者顯示所需的和已核准的許可權。 | MV2、MV3 |
權力 | 覆寫系統的電源管理功能。 | MV2、MV3 |
printerProvider | 使用事件來查詢印表機、其功能,以及提交列印作業。 | MV2、MV3 |
隱私 | 控制Microsoft Edge 中會影響用戶隱私權的功能。 此 API 取決於 的EdgeSetting types 原型,以取得並設定 Microsoft Edge 的組態。 |
MV2、MV3 |
過程 | 與瀏覽器的進程互動。 | MV2、MV3。 開發人員通道。 |
代理 | 管理 Microsoft Edge 的 Proxy 設定。 此 API 相依於 EdgeSetting API 的 types 原型,以取得和設定 Microsoft Edge 的 Proxy 設定。 |
MV2、MV3 |
運行 | 擷取背景頁面、傳回指令清單的詳細數據,以及接聽和回應應用程式或延伸模組生命週期中的事件。 您也可以將 URL 的相對路徑轉換成完整 URL。 | MV2、MV3 |
腳本 | 在不同的內容中執行腳本。 | MV3 |
搜索 | 使用預設提供者進行搜尋。 | MV2、MV3 |
會話 | 從瀏覽工作階段查詢和還原索引標籤和視窗。 | MV2、MV3 |
sidePanel | 在瀏覽器的提要字段中裝載自定義內容,以及網頁的主要內容。 請參閱 開發 Microsoft Edge 提要字段的擴充功能。 | MV3 |
存儲 | 儲存、擷取及追蹤用戶數據的變更。 | MV2、MV3 |
system.cpu | 查詢 CPU 元數據。 | MV2、MV3 |
system.display | 查詢會顯示元數據。 | MV2、MV3 |
system.memory | 報告可用的記憶體容量和物理記憶體容量總計。 | MV2、MV3 |
system.storage | 查詢存儲設備的相關信息。 您也可以在附加或中斷連結存放裝置時收到通知。 | MV2、MV3 |
tabCapture | 與索引標籤媒體串流互動。 | MV2、MV3 |
tabGroups | 與瀏覽器的索引標籤群組系統互動。 修改並重新排列瀏覽器中的索引標籤群組。 若要群組和取消群組索引標籤,或查詢群組中的索引標籤,請改用索引 標籤 API。 | MV3 |
製表元 | 與瀏覽器的索引標籤系統互動,以建立、修改及重新排列索引標籤。 | MV2、MV3 |
topSites | 存取顯示在新的索引標籤面上的熱門網站,也稱為 最常瀏覽的網站。 這些網站不包含使用者自定義的快捷方式。 | MV2、MV3 |
tts | 播放合成文字到語音轉換 (TTS) 。 | MV2、MV3 |
ttsEngine | 使用擴充功能實作文字到語音轉換 (TTS) 引擎。 註冊使用此 API 的擴充功能會接收包含要讀出之語句和其他參數的事件。 延伸模組接著可以使用任何可用的 Web 技術來合成和輸出語音,並將事件傳送回呼叫端函式以報告狀態。 | MV2、MV3 |
類型 | Microsoft Edge 的類型宣告。 | MV2、MV3 |
userScripts | 在使用者文稿內容中執行使用者腳本。 | MV3 |
webAuthenticationProxy | 讓在遠端主機上執行的遠端桌面軟體攔截 Web 驗證 API (WebAuthn) 要求,以便在本機用戶端上處理。 | MV3 |
webNavigation | 接收導覽要求狀態的相關通知。 | MV2、MV3 |
webRequest | 觀察和分析流量。 攔截、封鎖或修改要求。 | MV2、MV3 |
窗戶 | 與瀏覽器視窗互動,以在瀏覽器中建立、修改和重新排列視窗。 | MV2、MV3 |
不支援的 API
Microsoft Edge 不支援這些擴充功能 API。
API | 附註 |
---|---|
音訊 | 僅限 ChromeOS。 |
certificateProvider | 僅限 ChromeOS。 |
devtools.recorder | 僅限 Chrome DevTools。 |
documentScan | 僅限 ChromeOS。 |
enterprise.deviceAttributes | 僅限 ChromeOS。 |
enterprise.networkingAttributes | 僅限 ChromeOS。 |
enterprise.platformKeys | 僅限 ChromeOS。 |
fileBrowserHandler | 僅限 ChromeOS。 |
fileSystemProvider | 僅限 ChromeOS。 |
gcm | |
identity.getAccounts | |
identity.getAuthToken | 使用 在 的 oauth2 區段 manifest.json 中指定的用戶端識別碼和範圍,取得 OAuth2 存取令牌。 或者,您可以使用 identity.launchWebAuthFlow 來擷取 OAuth2 令牌來驗證使用者。 |
instanceID | |
loginState | 僅限 ChromeOS。 |
platformKeys | 僅限 ChromeOS。 |
印刷 | 僅限 ChromeOS。 |
printingMetrics | 僅限 ChromeOS。 |
readingList | |
vpnProvider | 僅限 ChromeOS。 |
壁紙 | 僅限 ChromeOS。 |
支援 API 的其他考慮
使用者必須使用 MSA) 或 Microsoft Entra ID 帳戶 (Microsoft帳戶登入 Microsoft Edge 才能使用
chrome.identity.getProfileUserInfo
。 如果使用者使用內部部署 Microsoft Entra ID 帳戶登入 Microsoft Edge,則 API 會傳回null
電子郵件和標識符值。MSA) (Microsoft 帳戶是 Outlook.com、Live.com 或 Hotmail.com 帳戶。
Microsoft Edge 不支援使用 Chrome Web Store 付款的延伸模組,因為它會使用
identity.getAuthtoken
來要求已登入使用者的令牌。 這些令牌會傳送至 REST 型授權 API。
注意事項
此頁面的部分是根據Google所建立和 共用的工作進行 修改,並根據 Creative Commons Attribution 4.0 國際授權中所述的條款使用。 您可以 在這裡找到原始頁面。
此工作是根據 Creative Commons Attribution 4.0 International License 授權。
另請參閱
- 指令清單 V2 的 Chrome 擴充功能 API 參考
- 指令清單 V3 的 Chrome 擴充功能 API 參考
- 使用 REST API 更新 Microsoft Edge 附加元件 - 在 Microsoft Edge 附加元件網站上更新延伸模組。