action.getUserSettings()

获取浏览器操作的用户指定设置。

注意:此 API 在清单 V3 或更高版本中可用。

这是一个异步函数,它返回一个 Promise

语法

js
let userSettings = await browser.action.getUserSettings();

参数

此函数不接受任何参数。

返回值

一个 Promise,它会解析为一个具有以下属性的对象

userSettings

一个包含浏览器操作的用户指定设置的对象,具有以下属性

isOnToolbar 可选

布尔值。用户是否已将操作的图标固定到浏览器 UI。此设置不指示操作图标是否可见。图标的可见性取决于浏览器窗口的大小和浏览器 UI 的布局。

示例

此代码记录一条消息,指示操作是否已固定。

js
function gotSettings(userSettings) {
  if (userSettings.isOnToolbar) {
    console.log("Action is pinned to toolbar.");
  } else {
    console.log("Action is not pinned to toolbar.");
  }
}

let gettingUserSettings = browser.action.getUserSettings();
gettingUserSettings.then(gotSettings);

浏览器兼容性

BCD 表格仅在启用 JavaScript 的浏览器中加载。

注意:此 API 基于 Chromium 的 chrome.action API。