windows.getCurrent()

Obtient la fenêtre actuelle du navigateur, en passant ses détails dans un rappel.

La fenêtre "actuelle" n'est pas nécessairement la même que la fenêtre ayant actuellement le focus. Si cette fonction est appelée à partir d'un script en arrière-plan, elle renvoie la fenêtre ayant actuellement le focus. Mais s'il est appelé à partir d'un script dont le document est associé à une fenêtre de navigateur particulière, il retourne la fenêtre de ce navigateur. Par exemple, si le navigateur affiche une barre latérale, chaque fenêtre de navigateur possède sa propre instance du document de la barre latérale. Si un script exécuté dans le document de la barre latérale appelle getCurrent(), il renverra la fenêtre de ce document de la barre latérale.

Il s'agit d'une fonction asynchrone qui renvoie une Promise.

Syntaxe

js
var gettingCurrent = browser.windows.getCurrent(
  getInfo, // optional object
);

Paramètres

getInfoFacultatif

object.

populateFacultatif

boolean. Si c'est vrai, l'objet windows.Window aura une propriété de tabulation contenant une liste d'objets tabs.Tab représentant les onglets de la fenêtre. Les objets Tab ne contiennent que les propriétés url, title et favIconUrl si le fichier manifest de l'extension comprend la permission "tabs".

windowTypesFacultatif

Un ensemble d'objets windows.WindowType. Si défini, le windows.Window retourné sera filtré en fonction de son type. Si désactivé, le filtre par défaut est réglé sur ['normal', 'panel', 'popup'], avec des types de fenêtres 'panneau' qui sont limités aux propres fenêtres de l'extension.

Note :

Si fourni, le composant windowTypes de getInfo est ignoré. L'utilisation de windowTypes a été dépréciée à partir de Firefox 62.

Valeur retournée

Une Promise qui sera remplie avec un objet windows.Window object contenant les détails de la fenêtre. Si une erreur survient, la promesse sera rejetée avec un message d'erreur.

Compatibilité des navigateurs

BCD tables only load in the browser

Exemples

Lorsque l'utilisateur clique sur l'icône d'une action du navigateur, cet exemple obtient la fenêtre actuelle et enregistre les URL des onglets qu'elle contient. Notez que vous aurez besoin de la permission "tabs" pour accéder aux URL des onglets.

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

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

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

Example extensions

Note :

Cette API est basée sur l'API de Chromnium chrome.windows. Cette documentation provient de windows.json dans le code de Chromium.

Les données de compatibilité Microsoft Edge sont fournies par Microsoft Corporation et sont incluses ici sous la licence Creative Commons Attribution 3.0 United States.