--- title: runtime.getBackgroundPage() slug: Mozilla/Add-ons/WebExtensions/API/runtime/getBackgroundPage tags: - API - Add-ons - Extensions - Method - Non-standard - Reference - WebExtensions - getBackgroundPage - runtime translation_of: Mozilla/Add-ons/WebExtensions/API/runtime/getBackgroundPage ---
Récupère l'objet Window
pour la page d'arrière-plan qui s'exécute dans l'extension en cours.
Cela consiste un moyen pratique pour d'autres scripts d'extension privilégiés d'accéder directement à la portée du script d'arrière plan. Cela leur permet d'accéder aux variables ou aux fonctions d'appel définies dans cette portée. Le "script privilégié" inclut ici les scripts s'exécutant dans les pages d'options, ou les scripts s'exécutant dans les fenêtres d'action du navigateur ou d'action page, mais n'inclut pas les scripts de contenu.
Notez que les variables déclarées à l'aide de const
ou let
n'apparaissaient pas dans l'objet window retourné par cette fonction.
Notez également que cette méthode ne peut pas être utilisée dans une fenêtre privée dans Firefox—Elle renvoie toujours null
. Pour plus d'informations voir le bug lié à bugzilla.
Si la page d'arrière plan est une page événement, le système s'assuera qu'il est chargé avant de résoudre la promise.
C'est une fonction asynchrone qui renvoie une Promise
.
var gettingPage = browser.runtime.getBackgroundPage()
None.
Une Promise
qui sera remplie avec l'objet Window pour la page d'arrière plan, s'il y en a une. Si l'extension n'inclut pas de page d'arrière-plan, la promise est rejetée avec un message d'erreur.
The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out https://github.com/mdn/browser-compat-data and send us a pull request.
{{Compat("webextensions.api.runtime.getBackgroundPage")}}
Supposons un script d'arrière-plan définisse une fonction foo()
:
// background.js function foo() { console.log("I'm defined in background.js"); }
Un script exécuté dans un popup peut appeler cette fonction directement comme ceci :
// popup.js function onGot(page) { page.foo(); } function onError(error) { console.log(`Error: ${error}`); } var getting = browser.runtime.getBackgroundPage(); getting.then(onGot, onError);
{{WebExtExamples}}
Cette API est basée sur l'API Chromium chrome.runtime
. Cette documentation est dérivée de runtime.json
dans le code de Chromium code.
Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.
// Copyright 2015 The Chromium Authors. All rights reserved. // // Redistribution and use in source and binary forms, with or without // modification, are permitted provided that the following conditions are // met: // // * Redistributions of source code must retain the above copyright // notice, this list of conditions and the following disclaimer. // * Redistributions in binary form must reproduce the above // copyright notice, this list of conditions and the following disclaimer // in the documentation and/or other materials provided with the // distribution. // * Neither the name of Google Inc. nor the names of its // contributors may be used to endorse or promote products derived from // this software without specific prior written permission. // // THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS // "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT // LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR // A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT // OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, // SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT // LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, // DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY // THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT // (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE // OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.