aboutsummaryrefslogtreecommitdiff
path: root/files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html
diff options
context:
space:
mode:
Diffstat (limited to 'files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html')
-rw-r--r--files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html140
1 files changed, 140 insertions, 0 deletions
diff --git a/files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html b/files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html
new file mode 100644
index 0000000000..fe6cee3398
--- /dev/null
+++ b/files/fr/mozilla/add-ons/webextensions/api/runtime/onconnectexternal/index.html
@@ -0,0 +1,140 @@
+---
+title: runtime.onConnectExternal
+slug: Mozilla/Add-ons/WebExtensions/API/runtime/onConnectExternal
+tags:
+ - API
+ - Add-ons
+ - Evènement
+ - Extensions
+ - Non-standard
+ - Reference
+ - WebExtensions
+ - onConnectExternal
+ - runtime
+translation_of: Mozilla/Add-ons/WebExtensions/API/runtime/onConnectExternal
+---
+<div>{{AddonSidebar()}}</div>
+
+<p>Lancé lorsqu'une extension reçoit une demande de connexion d'une extension différente.</p>
+
+<p>Pour envoyer un message qui sera reçu par le programme d'écoute <code>onConnectExternal</code>, utilisez {{WebExtAPIRef("runtime.connect()")}}, en transmettant l'ID du destinataire dans le paramètre <code>extensionId</code>.</p>
+
+<p>L'écouteur reçoit un objet {{WebExtAPIRef('runtime.Port')}} qu'il peut ensuite utiliser pour envoyer et recevoir des messages. L'objet <code>Port</code> contient également une propriété<code>sender</code>, qui est un objet {{WebExtAPIRef("runtime.MessageSender")}},  et que le destinataire peut utiliser pour vérifier l'ID de l'expéditeur.</p>
+
+<h2 id="Syntaxe">Syntaxe</h2>
+
+<pre class="syntaxbox brush:js">browser.runtime.onConnectExternal.addListener(listener)
+browser.runtime.onConnectExternal.removeListener(listener)
+browser.runtime.onConnectExternal.hasListener(listener)
+</pre>
+
+<p>Les événements ont trois fonctions :</p>
+
+<dl>
+ <dt><code>addListener(callback)</code></dt>
+ <dd>Ajoute un écouteur à cet événement.</dd>
+ <dt><code>removeListener(listener)</code></dt>
+ <dd>Arrêtez d'écouter cet événement. L'argument <code>listener</code> est l'écouteur à supprimer.</dd>
+ <dt><code>hasListener(listener)</code></dt>
+ <dd>Vérifie si un  <code>listener</code> est enregistré pour cet événement. Retourne <code>true</code> s'il écoute,  <code>false</code> sinon.</dd>
+</dl>
+
+<h2 id="Syntaxe_addListener">Syntaxe addListener</h2>
+
+<h3 id="Paramètres">Paramètres</h3>
+
+<dl>
+ <dt><code>fonction</code></dt>
+ <dd>
+ <p>Une fonction de rappel qui sera appelée lorsque cet événement se produira. La fonction recevra les arguments suivants :</p>
+
+ <dl class="reference-values">
+ <dt><code>port</code></dt>
+ <dd>Un objet {{WebExtAPIRef('runtime.Port')}} connectant le script en cours à l'autre extension à laquelle il se connecte.</dd>
+ </dl>
+ </dd>
+</dl>
+
+<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.runtime.onConnectExternal")}}</p>
+
+<h2 id="Exemples">Exemples</h2>
+
+<p>Dans cet exemple, l'extension Hansel se connecte à l'extension Gretel :</p>
+
+<pre class="brush: js">console.log("connecting to Gretel");
+var myPort = browser.runtime.connect(
+ "gretel@mozilla.org"
+);
+
+myPort.onMessage.addListener((message) =&gt; {
+ console.log(`From Gretel: ${message.content}`);
+});
+
+browser.browserAction.onClicked.addListener(() =&gt; {
+ myPort.postMessage({content: "Hello from Hansel"});
+});</pre>
+
+<p>Gretel écoute la connexion  et vérifie que l'expéditeur est vraiment Hansel:</p>
+
+<pre class="brush: js">var portFromHansel;
+
+browser.runtime.onConnectExternal.addListener((port) =&gt; {
+ console.log(port);
+ if (port.sender.id === "hansel@mozilla.org") {
+ console.log("connection attempt from Hansel");
+ portFromHansel = port;
+ portFromHansel.onMessage.addListener((message) =&gt; {
+ console.log(`From Hansel: ${message.content}`);
+ });
+ }
+});
+
+browser.browserAction.onClicked.addListener(() =&gt; {
+ portFromHansel.postMessage({content: "Message from Gretel"});
+});
+
+</pre>
+
+<p>{{WebExtExamples}}</p>
+
+<div class="note"><strong>Remerciements :</strong>
+
+<p>Cette API est basée sur l'API Chromium <a href="https://developer.chrome.com/extensions/runtime#event-onConnect"><code>chrome.runtime</code></a>. Cette documentation est dérivée de <a href="https://chromium.googlesource.com/chromium/src/+/master/extensions/common/api/runtime.json"><code>runtime.json</code></a> dans le code de Chromium code.</p>
+
+<p>Les données de compatibilité relatives à Microsoft Edge sont fournies par Microsoft Corporation et incluses ici sous la licence Creative Commons Attribution 3.0 pour les États-Unis.</p>
+</div>
+
+<div class="hidden">
+<pre>// Copyright 2015 The Chromium Authors. All rights reserved.
+//
+// Redistribution and use in source and binary forms, with or without
+// modification, are permitted provided that the following conditions are
+// met:
+//
+// * Redistributions of source code must retain the above copyright
+// notice, this list of conditions and the following disclaimer.
+// * Redistributions in binary form must reproduce the above
+// copyright notice, this list of conditions and the following disclaimer
+// in the documentation and/or other materials provided with the
+// distribution.
+// * Neither the name of Google Inc. nor the names of its
+// contributors may be used to endorse or promote products derived from
+// this software without specific prior written permission.
+//
+// THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+// "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+// LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+// A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+// OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+// SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+// LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+// DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+// THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+// (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+// OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+</pre>
+</div>