aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md
diff options
context:
space:
mode:
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md')
-rw-r--r--files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md b/files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md
new file mode 100644
index 0000000000..c81dbd0ab1
--- /dev/null
+++ b/files/fr/mozilla/add-ons/webextensions/api/sessions/setwindowvalue/index.md
@@ -0,0 +1,68 @@
+---
+title: sessions.setWindowValue()
+slug: Mozilla/Add-ons/WebExtensions/API/sessions/setWindowValue
+tags:
+ - API
+ - Add-ons
+ - Extensions
+ - Method
+ - Reference
+ - WebExtensions
+ - sessions
+ - setWindowsValue
+translation_of: Mozilla/Add-ons/WebExtensions/API/sessions/setWindowValue
+---
+<div>{{AddonSidebar()}}</div>
+
+<p>Stocke une paire clé / valeur à associer à une fenêtre donnée. Vous pouvez ensuite récupérer cette valeur en utilisant {{WebExtAPIRef("sessions.getWindowValue")}}.</p>
+
+<p>Notez que ces données ne seront visibles que par l'extension qui l'a définie, et non par les autres extensions..</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="brush: js">var storing = browser.sessions.setWindowValue(
+ windowId, // integer
+ key, // string
+ value // string or object
+)
+</pre>
+
+<h3 id="Paramètres">Paramètres</h3>
+
+<dl>
+ <dt><code>windowId</code></dt>
+ <dd><code>integer</code>. ID de la fenêtre avec laquelle vous souhaitez associer les données.</dd>
+ <dt><code>key</code></dt>
+ <dd><code>string</code>. Clé que vous pouvez utiliser ultérieurement pour récupérer cette valeur de données particulière.</dd>
+ <dt><code>value</code></dt>
+ <dd><code>string</code> ou <code>object</code>. S'il s'agit d'un objet, il est <a href="/fr/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify">stringified</a>, donc les méthodes d'objet, par exemple, seront omises. Si une fonction est donnée ici, elle sera stockée sous la valeur <code>null</code>.</dd>
+</dl>
+
+<h3 id="Valeur_retournée">Valeur retournée</h3>
+
+<p>Une <code><a href="/fr/docs/Web/JavaScript/Reference/Objets_globaux/Promise">Promise</a></code> qui sera résolue sans argument si l'appel a réussi. 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>{{Compat("webextensions.api.sessions.setWindowValue", 10)}}</p>
+
+<h2 id="Exemples">Exemples</h2>
+
+<p>Définissez une valeur sur la fenêtre active lorsque l'utilisateur sélectionne un élément de menu. Notez que vous aurez besoin de la  <a href="/fr/Add-ons/WebExtensions/manifest.json/permissions">permission</a> "menus" pour exécuter cet exemple :</p>
+
+<pre class="brush: js">async function setOnActiveWindow() {
+ let currentWindow = await browser.windows.getLastFocused();
+ await browser.sessions.setWindowValue(currentWindow.id, "my-key", "my-value");
+}
+
+browser.menus.create({
+ id: "my-item",
+ title: "my item",
+ contexts: ["all"]
+});
+
+browser.menus.onClicked.addListener(setOnActiveWindow);</pre>
+
+<p>{{WebExtExamples}}</p>