aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/search/get/index.html
blob: d5b9ce947f4bd736ce3d3110e20f390563609ff7 (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
69
---
title: search.get()
slug: Mozilla/Add-ons/WebExtensions/API/search/get
tags:
  - API
  - Add-ons
  - Extensions
  - Reference
  - Search
  - WebExtensions
  - get
translation_of: Mozilla/Add-ons/WebExtensions/API/search/get
---
<div>{{AddonSidebar()}}</div>

<p>Obtient un tableau de tous les moteurs de recherche installés.</p>

<p>Chaque moteur de recherche renvoyé est identifié par un nom, que vous pouvez passer dans {{WebExtAPIRef("search.search()")}}} pour utiliser ce moteur particulier pour effectuer une recherche.</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 gettingEngines = browser.search.get()
</pre>

<h3 id="Paramètres">Paramètres</h3>

<p>Aucun.</p>

<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 avec un <a href="Web/JavaScript/Reference/Global_Objects/array">tableau</a> d'objets  de moteur de recherche. Chaque objet de moteur de recherche peut contenir les propriétés suivantes :</p>

<dl class="reference-values">
 <dt><code>name</code></dt>
 <dd><code>string</code>. Le nom du moteur de recherche.</dd>
 <dt><code>isDefault</code></dt>
 <dd>
 <p><code>boolean</code>. <code>true</code> si le moteur de recherche est le moteur par défaut. Un seul moteur de recherche peut être le moteur par défaut à un moment donné.</p>
 </dd>
 <dt><code>alias</code>{{optional_inline}}</dt>
 <dd>
 <p><code>string</code>. Si un moteur de recherche a un alias, l'utilisateur peut effectuer une recherche avec un moteur de recherche particulier en entrant l'alias dans la barre d'adresse avant le terme de recherche. Par exemple, si le moteur Wikipedia a un alias "wk", l'utilisateur peut rechercher des pandas dans Wikipedia en entrant "wk pandas" dans la barre d'adresse. L'alias est parfois aussi appelé "mot-clé".</p>
 </dd>
 <dt><code>favIconUrl</code>{{optional_inline}}</dt>
 <dd>
 <p><code>string</code>. L'icône du moteur de recherche, comme une donnée : URL.</p>
 </dd>
</dl>

<h2 id="Compatibilité_du_navigateur">Compatibilité du navigateur</h2>

<p>{{Compat("webextensions.api.search.search", 10)}}</p>

<h2 id="Exemples">Exemples</h2>

<p>Obtenir tous les moteurs de recherche installés :</p>

<pre class="brush: js">function retrieved(results) {
  console.log(`There were: ${results.length} search engines retrieved.`);
  for (let searchEngine of results) {
    console.log(JSON.stringify(searchEngine.name));
  }
}

browser.search.get().then(retrieved);</pre>

<p>{{WebExtExamples}}</p>