Spec-Zone.ru › Web Extensions

windows.get()

Получает сведения о окне по его идентификатору. Сведения передаются в обратный вызов.

Это асинхронная функция, которая возвращает Promise.

Синтаксис

let getting = browser.windows.get(
  windowId,              // integer
  getInfo                // optional object
)

Параметры

windowId

integer. Идентификатор объекта окна, сведения о котором требуется получить.

getInfo Необязательно

object. Содержит параметры для фильтрации типа окна.

populate Необязательно

boolean. Если true, объект windows.Window будет содержать свойство tabs, которое содержит список объектов tabs.Tab, представляющих открытые в окне вкладки. Объекты Tab содержат только свойства url, title и favIconUrl, если в манифесте расширения указано разрешение "tabs" или соответствующее разрешение разрешение на доступ к хосту.

windowTypes Необязательно

array объектов windows.WindowType. Если задано, возвращаемое значение windows.Window будет отфильтровано по типу. Если не задано, по умолчанию применяется фильтр ['normal', 'panel', 'popup'], с ограничениями на типы окон 'panel' до окон самого расширения.

Примечание: Если задано, компонент windowTypes в getInfo игнорируется. Использование windowTypes устарело с Firefox 62.

Возвращаемое значение

A Promise, который будет выполнен с объектом windows.Window, содержащим сведения о окне. При возникновении ошибки обещание будет отклонено с сообщением об ошибке.

Совместимость с браузерами

Рабочий стол Мобильные устройства
Chrome Edge Firefox Internet Explorer Opera Safari WebView Android Chrome Android Firefox for Android Opera Android Safari on IOS Samsung Internet
get Да 14 45 ? Да 14 ? ? Нет ? 15 ?
getInfo 18 14 45 ? 15 14 ? ? Нет ? 15 ?

Примеры

В этом примере получаются текущее окно и выводится список URL-адресов входящих в него вкладок. Для доступа к URL-адресам вкладок необходимо разрешение "tabs" или соответствующее разрешение на доступ к хосту.

Примечание: Данный пример несколько нереалистичен: в данной ситуации более вероятно использование windows.getCurrent().

function logTabs(windowInfo) {
  for (const tabInfo of windowInfo.tabs) {
    console.log(tabInfo.url);
  }
}

function onError(error) {
  console.error(`Error: ${error}`);
}

browser.browserAction.onClicked.addListener((tab) => {
  browser.windows.get(tab.windowId, { populate: true }).then(logTabs, onError);
});

Примечание: Этот API основан на API chrome.windows Chromium. Данная документация взята из windows.json кода Chromium.

© 2005–2023 MDN contributors.
Licensed under the Creative Commons Attribution-ShareAlike License v2.5 or later.
https://developer.mozilla.org/en-US/docs/Mozilla/Add-ons/WebExtensions/API/windows/get

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API