blob: b5dc3024ca5cb05d7a9d057da847ff9f85ceae21 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
|
---
title: commands.update()
slug: Mozilla/Add-ons/WebExtensions/API/commands/update
tags:
- API
- Add-ons
- Extensions
- Method
- Reference
- Update
- WebExtensions
- commands
translation_of: Mozilla/Add-ons/WebExtensions/API/commands/update
---
<div>{{AddonSidebar()}}</div>
<p>Changez la description ou le raccourci clavier pour la commande donnée.</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">browser.commands.update(
details // object
);
</pre>
<h3 id="Paramètres">Paramètres</h3>
<dl>
<dt><code>details</code></dt>
<dd><code>object</code>. Un objet avec les propriétés suivantes:</dd>
<dd>
<dl class="reference-values">
<dt><code>name</code></dt>
<dd><code>string</code>. e nom de la commande à mettre à jour. Cela doit correspondre au nom d'une commande existante, comme indiqué par exemple dans la propriété <code>name</code> de l'objet {{WebExtAPIRef("commands.Command")}}.</dd>
<dt><code>description</code>{{optional_inline}}</dt>
<dd><code>string</code>. Une nouvelle description à définir pour la commande.</dd>
<dt><code>shortcut</code>{{optional_inline}}</dt>
<dd><code>string</code>. Un nouveau raccourci à définir pour la commande. Cela doit correspondre au format donné dans la documentation pour les <a href="/fr/Add-ons/WebExtensions/manifest.json/commands"><code>commands</code> de la clé manifest.json</a>. S'il ne correspond pas à ce format, la fonction va générer une erreur.</dd>
</dl>
</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 remplie sans arguments lorsque le raccourci a été réinitialisé. La promesse sera rejetée avec une erreur si la commande n'a pas pu être trouvée.</p>
<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2>
<p>{{Compat("webextensions.api.commands.update")}}</p>
<h2 id="Exemples">Exemples</h2>
<p>Met à jour la commande "my-command" avec la valeur de raccourci donnée, lorsque l'utilisateur clique sur "update" :</p>
<pre class="brush: js">const commandName = 'my-command';
function updateShortcut() {
browser.commands.update({
name: commandName,
shortcut: document.querySelector('#shortcut').value
});
}
document.querySelector('#update').addEventListener('click', updateShortcut);</pre>
<p>{{WebExtExamples}}</p>
|
