windows.get()
Obtient les détails sur une fenêtre, compte tenu de son identifiant. Les détails sont transmis à un rappel.
Il s'agit d'une fonction asynchrone qui renvoit une Promise
.
Syntaxe
var getting = browser.windows.get(
windowId, // integer
getInfo, // optional object
);
Paramètres
windowId
-
integer
. L'ID de l'objet de fenêtre souhaité est retourné. getInfo
Facultatif-
object
. Contient des options pour filtrer le type de fenêtre.populate
Facultatif-
boolean
. Si c'est vrai, l'objetwindows.Window
aura une propriété de tabulation qui contient une liste d'objetstabs.Tab
représentant les onglets ouverts dans la fenêtre. Les objets Tab ne contiennent que les propriétésurl
,title
etfavIconUrl
i le fichier manifeste de l'extension comprend la permission"tabs"
. windowTypes
Facultatif-
Ensemble d'objets
windows.WindowType
. Si défini, le retour dewindows.Window
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'panel'
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 de retour
Une Promise
qui sera remplie avec un objet windows.Window
contenant les détails de la fenêtre. Si une erreur survient, la promesse sera rejetée avec un message d'erreur.
Exemples
Cet exemple obtient la fenêtre actuelle et enregistre les URL des onglets qu'il contient. Notez que vous aurez besoin des permission "onglets" pour accéder aux URL des onglets.
Note : Cet exemple est un peu irréaliste: dans cette situation, vous utiliserez probablement windows.getCurrent()
.
function logTabs(windowInfo) {
for (tabInfo of windowInfo.tabs) {
console.log(tabInfo.url);
}
}
function onError(error) {
console.log(`Error: ${error}`);
}
browser.browserAction.onClicked.addListener((tab) => {
var getting = browser.windows.get(tab.windowId, { populate: true });
getting.then(logTabs, onError);
});
Compatibilité des navigateurs
BCD tables only load in the browser
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.