Window : évènement message

Syntaxe

Utilisez le nom de l'évènement dans des méthodes comme addEventListener(), ou définissez une propriété de gestionnaire d'événements.

addEventListener("message", (event) => { })

onmessage = (event) => { }

Type d'évènement

Un objet MessageEvent. Hérite de Event.

Propriétés de l'évènement

Cette interface hérite également des propriétés de son parent, Event.

MessageEvent.data Lecture seule

Les données envoyées par l'émetteur du message.

MessageEvent.origin Lecture seule

Une chaîne de caractères représentant l'origine de l'émetteur du message.

MessageEvent.lastEventId Lecture seule

Une chaîne de caractères représentant un identifiant unique pour l'évènement.

MessageEvent.source Lecture seule

Un objet MessageEventSource (qui peut être un WindowProxy, MessagePort, ou ServiceWorker) représentant l'émetteur du message.

MessageEvent.ports Lecture seule

Un tableau d'objets MessagePort représentant les ports associés au canal par lequel le message est envoyé (le cas échéant, par exemple, dans la messagerie de canal ou lors de l'envoi d'un message à un worker partagé).

Exemples

Supposons qu'un script envoie un message à un contexte de navigation différent, tel qu'un autre <iframe>, en utilisant un code comme celui-ci :

const targetFrame = window.top.frames[1];
const targetOrigin = "https://exemple.org";
const windowMessageButton = document.querySelector("#window-message");

windowMessageButton.addEventListener("click", () => {
  targetFrame.postMessage("bonjour", targetOrigin);
});

Le récepteur peut écouter le message en utilisant addEventListener() avec un code comme celui-ci :

window.addEventListener("message", (event) => {
  console.log(`Message reçu : ${event.data}`);
});

Alternativement l'écouteur peut utiliser la propriété du gestionnaire d'évènements onmessage :

window.onmessage = (event) => {
  console.log(`Message reçu : ${event.data}`);
};

Spécifications

Compatibilité des navigateurs

Voir aussi

• Évènement associé : messageerror
• La propriété Window.postMessage()