diff options
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/sessions/settabvalue/index.html')
| -rw-r--r-- | files/fr/mozilla/add-ons/webextensions/api/sessions/settabvalue/index.html | 71 |
1 files changed, 71 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/sessions/settabvalue/index.html b/files/fr/mozilla/add-ons/webextensions/api/sessions/settabvalue/index.html new file mode 100644 index 0000000000..9f02e440d9 --- /dev/null +++ b/files/fr/mozilla/add-ons/webextensions/api/sessions/settabvalue/index.html @@ -0,0 +1,71 @@ +--- +title: sessions.setTabValue() +slug: Mozilla/Add-ons/WebExtensions/API/sessions/setTabValue +tags: + - API + - Add-ons + - Extensions + - Method + - Reference + - WebExtensions + - sessions + - setTabValue +translation_of: Mozilla/Add-ons/WebExtensions/API/sessions/setTabValue +--- +<div>{{AddonSidebar()}}</div> + +<p>Stocke une paire clé / valeur à associer à un onglet donné. Vous pouvez ensuite récupérer cette valeur en utilisant {{WebExtAPIRef("sessions.getTabValue")}}.</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="syntaxbox brush:js">var storing = browser.sessions.setTabValue( + tabId, // integer + key, // string + value // string or object +) +</pre> + +<h3 id="Paramètres">Paramètres</h3> + +<dl> + <dt><code>tabId</code></dt> + <dd><code>integer</code>. ID de l'onglet avec lequel 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 forme <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 l'onglet 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.setTabValue", 10)}}</p> + +<h2 id="Exemples">Exemples</h2> + +<p>Définissez une valeur sur l'onglet actif 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 setOnActiveTab() { + let tabArray = await browser.tabs.query({currentWindow: true, active: true}); + let tabId = tabArray[0].id; + await browser.sessions.setTabValue(tabId, "my-key", "my-value"); +} + +browser.menus.create({ + id: "my-item", + title: "my item", + contexts: ["all"] +}); + +browser.menus.onClicked.addListener(setOnActiveTab);</pre> + +<p>{{WebExtExamples}}</p> |
