From ed27358bb580f8366fadca2124a7477814b7e16e Mon Sep 17 00:00:00 2001 From: Joris Daniel Date: Sat, 20 Mar 2021 11:10:41 +0100 Subject: Update french translation - WebExt - Misc (#153) * Update french translation * Update content from english * updating onmesssage (webext api) to parity w/ en-US * Bring "your first webextension" to parity w/ current en-us * Complete fr translation Co-authored-by: SphinxKnight --- .../webextensions/api/runtime/onmessage/index.html | 75 +++++++++++----------- 1 file changed, 38 insertions(+), 37 deletions(-) (limited to 'files/fr/mozilla/add-ons/webextensions/api/runtime/onmessage/index.html') diff --git a/files/fr/mozilla/add-ons/webextensions/api/runtime/onmessage/index.html b/files/fr/mozilla/add-ons/webextensions/api/runtime/onmessage/index.html index c1267fff27..eae7a8a907 100644 --- a/files/fr/mozilla/add-ons/webextensions/api/runtime/onmessage/index.html +++ b/files/fr/mozilla/add-ons/webextensions/api/runtime/onmessage/index.html @@ -15,56 +15,57 @@ translation_of: Mozilla/Add-ons/WebExtensions/API/runtime/onMessage --- -

Utilisez cet événement pour écouter les messages d’une autre partie de votre extension. Par exemple, utilisez-le :

+

Utilisez cet événement pour écouter les messages d’une autre partie de votre extension.

Voici quelques exemples de cas d'utilisation :

Pour envoyer un message reçu par l'écouteur onMessage, utilisez {{WebExtAPIRef("runtime.sendMessage()")}} ou (pour envoyer un message à un script de contenu) {{WebExtAPIRef("tabs.sendMessage()")}}.

-

Évitez de créer plusieurs écouteurs onMessage pour le même type de message, car l'ordre dans lequel plusieurs auditeurs vont tirer n'est pas garanti.

+

Évitez de créer plusieurs écouteurs onMessage pour le même type de message, car l'ordre de déclenchement des différents écouteurs ne sera pas garanti.

-

Lorsque vous voulez garantir la livraison d'un message à un point final spécifique, utilisez l'approche basée sur la connexion pour échanger des messages.

+

Lorsque vous voulez garantir la livraison d'un message à une terminaison spécifique, utilisez l'approche basée sur la connexion pour échanger des messages.

-

Avec le message lui-même, l’écouteur reçoit en paramètres :

+

En plus du message, l’écouteur reçoit en paramètres :

-

Vous pouvez envoyer une réponse synchrone au message en appelant la fonction sendResponse dans votre écouteur. Voir un exemple.

+

Vous pouvez envoyer une réponse synchrone au message en appelant la fonction sendResponse() dans votre écouteur. Voir un exemple.

-

Pour envoyer un réponse asynchrone, il existe deux options :

+

Pour envoyer une réponse asynchrone, il existe deux options :

-

Retourner une Promise est maintenant le moyen préféré car sendResponse sera retirée de la spécification W3C.

+

Retourner une promesse (Promise) est désormais la méthode à privilégier car sendResponse() sera retirée de la spécification W3C.

La bibliothèque populaire webextension-polyfill a déjà supprimé cette fonction de son implémentation.

Syntaxe

-
browser.runtime.onMessage.addListener(listener)
-browser.runtime.onMessage.removeListener(listener)
-browser.runtime.onMessage.hasListener(listener)
+
browser.runtime.onMessage.addListener(listener)
+browser.runtime.onMessage.removeListener(listener)
+browser.runtime.onMessage.hasListener(listener)
+

Les événements ont trois fonctions :

@@ -88,7 +89,7 @@ browser.runtime.onMessage.hasListener(listener)
message
-
object. Le message lui-même. C’est un objet JSON-ifiable.
+
Un objet qui est le message lui-même. C’est un objet sérialisable (voir l'algorithme de clonage de données).
@@ -99,17 +100,17 @@ browser.runtime.onMessage.hasListener(listener)
sendResponse
-

Une fonction à appeler, au plus une fois, pour envoyer une réponse au message. La fonction prend un seul argument, qui peut être n'importe quel objet JSON-ifiable. Cet argument est renvoyé à l'expéditeur du message.

+

Une fonction à appeler, au plus une fois, pour envoyer une réponse au message. La fonction prend un seul argument, qui peut être n'importe quel objet sérialisable (voir l'algorithme de clonage de données). Cet argument est renvoyé à l'expéditeur du message.

Si vous avez plus d'un écouteur onMessage() dans le même document, alors un seul peut envoyer une réponse.

Pour envoyer une réponse de manière synchrone, appelez sendResponse() avant le retour de la fonction d'écoute.

-

Pour envoyer une réponse de manière asynchrone

+

Pour envoyer une réponse de manière asynchrone :

    -
  • soit garder une référence à l'argument sendResponse() et retourner true depuis la fonction listenener. Vous pourrez alors appeler sendResponse() après le retour de la fonction d'écoute.
  • -
  • ou retournez une {{jsxref("Promise")}} à partir de la fonction d'écoute et résolvez la promise lorsque la réponse est prête. C'est un moyen privilégié
  • +
  • soit on gardera une référence à l'argument sendResponse() et on retournera true depuis la fonction listenener. sendResponse() pourra être appelée après le retour de la fonction d'écoute.
  • +
  • ou on retournera {{jsxref("Promise")}} à partir de la fonction d'écoute et on résoudra la promesse lorsque la réponse sera prête. C'est la méthode à privilégier.
@@ -117,9 +118,9 @@ browser.runtime.onMessage.hasListener(listener)

La fonction listener peut renvoyer un booléen ou une {{jsxref("Promise")}}.

-

Important: N'appelez pas addListener() en utilisant une fonction  async :

+

Important: N'appelez pas addListener() en utilisant une fonction async :

-
// don't do this
+ 
// ne faites pas ça
 browser.runtime.onMessage.addListener(
   async (data, sender) => {
     if (data.type === 'handle_me') { return 'done'; }
@@ -127,9 +128,9 @@ browser.runtime.onMessage.addListener(
 );
 
-

L'auditeur consommera ainsi chaque message qu'il reçoit, ce qui empêchera effectivement tous les autres auditeurs de recevoir et de traiter des messages.

+

L'écouteur consommera ainsi chaque message qu'il reçoit, ce qui empêchera effectivement tous les autres écouteurs de recevoir et de traiter des messages.

-

Si vous souhaitez adopter une approche asynchrone, utilisez plutôt une Promise, comme ceci :

+

Si vous souhaitez adopter une approche asynchrone, utilisez plutôt une Promise, comme ceci :

browser.runtime.onMessage.addListener(
   (data, sender) => {
@@ -147,11 +148,11 @@ browser.runtime.onMessage.addListener(
 
 
 
-

{{Compat("webextensions.api.runtime.onMessage()")}}

+

{{Compat("webextensions.api.runtime.onMessage")}}

-

Exemples

+

Exemples

-

Exemple simple

+

Exemple simple

Ce script de contenu écoute les événements clic dans la page web. Si le clic a eu lieu sur un lien, il envoie un message à la page d’arrière-plan avec l’URL cible :

@@ -166,7 +167,7 @@ function notifyExtension(e) { browser.runtime.sendMessage({"url": e.target.href}); }
-

Le script d’arrière-plan écoute ces messages et affiche une notification à l’aide de l’API notifications.

+

Le script d’arrière-plan écoute ces messages et affiche une notification à l’aide de l’API notifications.

// background-script.js
 
@@ -181,9 +182,9 @@ function notify(message) {
   });
 }
-

Envoyer une réponse synchrone

+

Envoyer une réponse synchrone

-

Le script de contenu suivant envoie un message au script d’arrière plan lorsque l’utilisateur ou l’utilisatrice clique sur la page. Il enregistre également toute réponse envoyé par le script d’arrière-plan :

+

Le script de contenu suivant envoie un message au script d’arrière-plan lorsque l’utilisateur ou l’utilisatrice clique sur la page. Il enregistre également toute réponse envoyée par le script d’arrière-plan :

// content-script.js
 
@@ -224,9 +225,9 @@ function handleMessage(request, sender, sendResponse) {
 
 browser.runtime.onMessage.addListener(handleMessage);
-

Envoi d’une réponse asynchrone à l’aide de sendResponse

+

Envoi d’une réponse asynchrone à l’aide de sendResponse

-

Voici un autre version du script d’arrière-plan de l’exemple précédent. Il envoie une réponse de manière asynchrone, après le retour de l’écouteur. Remarquez le return true; dans l’écouteur : cela indique au navigateur que vous avez l’intention d’utiliser l’argument sendResponse après le retour de l’écouteur.

+

Voici une autre version du script d’arrière-plan de l’exemple précédent. Il envoie une réponse de manière asynchrone, après le retour de l’écouteur. Remarquez le return true; dans l’écouteur : cela indique au navigateur que vous avez l’intention d’utiliser l’argument sendResponse() après le retour de l’écouteur.

// background-script.js
 
@@ -240,7 +241,7 @@ function handleMessage(request, sender, sendResponse) {
 
 browser.runtime.onMessage.addListener(handleMessage);
-

Envoi d’une réponse asynchrone à l’aide d’une promesse

+

Envoi d’une réponse asynchrone à l’aide d’une promesse

Ce script de contenu reçoit le premier lien <a> dans la page, et envoie un message demandant si l’emplacement du lien fait partie des marque-pages. Il attend comme réponse un {{jsxref("Boolean", "booléen")}} : true si l’emplacement est dans les marque-pages, false sinon.

@@ -258,7 +259,7 @@ browser.runtime.sendMessage({ url: firstLink.href }).then(handleResponse);
-

Voici le script d’arrière plan. Il utilise {{WebExtAPIRef("bookmarks.search()")}} pour voir si le lien est dans les marque-pages, ce qui renvoie une {{jsxref("Promise", "promesse")}} :

+

Voici le script d’arrière-plan. Il utilise {{WebExtAPIRef("bookmarks.search()")}} pour voir si le lien est dans les marque-pages, ce qui renvoie une {{jsxref("Promise", "promesse")}} :

// background-script.js
 
@@ -272,7 +273,7 @@ function isBookmarked(message, sender, response) {
 
 browser.runtime.onMessage.addListener(isBookmarked);
-

Si le gestionnaire asynchrone ne renvoie pas de promise, vous pouvez explicitement construire une promise. Cet exemple plutôt artificiel envoie une réponse après un délai d’une seconde, en utilisant Window.setTimeout() :

+

Si le gestionnaire asynchrone ne renvoie pas de promesse, vous pouvez explicitement construire une promesse. Cet exemple plutôt artificiel envoie une réponse après un délai d’une seconde, en utilisant Window.setTimeout() :

// background-script.js
 
-- 
cgit v1.2.3-54-g00ecf