diff options
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/sessions/getwindowvalue/index.html')
-rw-r--r-- | files/fr/mozilla/add-ons/webextensions/api/sessions/getwindowvalue/index.html | 66 |
1 files changed, 66 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/sessions/getwindowvalue/index.html b/files/fr/mozilla/add-ons/webextensions/api/sessions/getwindowvalue/index.html new file mode 100644 index 0000000000..ffdb95065d --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/sessions/getwindowvalue/index.html @@ -0,0 +1,66 @@ +--- +title: sessions.getWindowValue() +slug: Mozilla/Add-ons/WebExtensions/API/sessions/getWindowValue +tags: + - API + - Add-ons + - Extensions + - Method + - Reference + - WebExtensions + - getWindowValue + - sessions +translation_of: Mozilla/Add-ons/WebExtensions/API/sessions/getWindowValue +--- +<div>{{AddonSidebar()}}</div> + +<p>Récupère une valeur précédemment stockée par un appel à {{WebExtAPIRef("sessions.setWindowValue")}}.</p> + +<p>Vous pouvez récupérer une valeur d'une fenêtre même sur un cycle de fermeture / restauration : si vous définissez une valeur, l'utilisateur ferme la fenêtre, puis restaure la fenêtre à l'aide de la fonction "restaurer la fenêtre" du navigateur (par exemple, en appuyant sur Control+Shift+N),vous pourrez récupérer la valeur de la fenêtre restaurée. otez cependant qu'une fenêtre restaurée n'obtient pas le même ID que l'original, donc l'ID que vous passez dans <code>getWindowValue()</code> sera différent de l'ID que vous avez passé dans <code>setWindowValue()</code>, même s'ils se réfèrent tous les deux à la même fenêtre.</p> + +<p>C'est une fonction asynchrone qui renvoie une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code>.</p> + +<h2 id="Syntaxe">Syntaxe</h2> + +<pre class="syntaxbox brush:js">var retrieving = browser.sessions.getWindowValue( + windowId, // integer + key // string +) +</pre> + +<h3 id="Paramètres">Paramètres</h3> + +<dl> + <dt><code>windowId</code></dt> + <dd><code>integer</code>. ID de la fenêtre dont vous essayez de récupérer les données.</dd> + <dt><code>key</code></dt> + <dd><code>string</code>. Clé identifiant la valeur particulière à récupérer. Cela doit correspondre à la clé précédemment donnée dans {{WebExtAPIRef("sessions.setWindowValue")}}.</dd> +</dl> + +<h3 id="Valeure_retournée">Valeure retournée</h3> + +<p>Une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code> qui sera résolue avec la valeur si elle existe, ou <code>undefined</code> si elle n'existe pas. Si l'appel a échoué (par exemple, parce que l'ID de la fenêtre n'a pas pu être trouvé), la promesse sera rejetée avec un message d'erreur.</p> + +<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2> + +<p class="hidden">The compatibility table in this page is generated from structured data. If you'd like to contribute to the data, please check out <a href="https://github.com/mdn/browser-compat-data">https://github.com/mdn/browser-compat-data</a> and send us a pull request.</p> + +<p>{{Compat("webextensions.api.sessions.getWindowValue", 10)}}</p> + +<h2 id="Exemples">Exemples</h2> + +<p>Consignez la valeur de "my-key" pour toutes les fenêtres nouvellement créées (cela inclura toutes les fenêtres qui ont été restaurées) :</p> + +<pre class="brush: js">function onGetResolved(r) { + console.log(`success: ${r}`); +} + +function onGetRejected(e) { + console.log(`error: ${e}`); +} + +browser.windows.onCreated.addListener((window) => { + browser.sessions.getWindowValue(window.id, "my-key").then(onGetResolved, onGetRejected); +});</pre> + +<p>{{WebExtExamples}}</p> |