Skip to content

Latest commit

 

History

History
84 lines (57 loc) · 2.98 KB

File metadata and controls

84 lines (57 loc) · 2.98 KB
title slug l10n
EventSource: message イベント
Web/API/EventSource/message_event
sourceCommit
1511e914c6b1ce6f88056bfefd48a6aa585cebce

{{APIRef}}

message は {{domxref("EventSource")}} API のイベントで、イベントソースからデータを受け取ったときに発生します。

このイベントはキャンセル不可で、バブリングしません。

構文

このイベント名を {{domxref("EventTarget.addEventListener", "addEventListener()")}} などのメソッドで使用するか、イベントハンドラープロパティを設定するかしてください。

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

onmessage = (event) => {};

イベント型

{{domxref("MessageEvent")}} です。 {{domxref("Event")}} を継承しています。

{{InheritanceDiagram("MessageEvent")}}

イベントプロパティ

このインターフェイスは親である {{domxref("Event")}} からプロパティを継承しています。

  • {{domxref("MessageEvent.data")}} {{ReadOnlyInline}}
    • : メッセージ送信元によって送信されたデータです。
  • {{domxref("MessageEvent.origin")}} {{ReadOnlyInline}}
    • : 文字列で、メッセージ送信元のオリジンを表します。
  • {{domxref("MessageEvent.lastEventId")}} {{ReadOnlyInline}}
    • : 文字列で、このイベントの一意の ID を表します。
  • {{domxref("MessageEvent.source")}} {{ReadOnlyInline}}
    • : MessageEventSource ({{domxref("WindowProxy")}}、{{domxref("MessagePort")}}、{{domxref("ServiceWorker")}} の何れかのオブジェクト)で、メッセージの送信元を表します。
  • {{domxref("MessageEvent.ports")}} {{ReadOnlyInline}}
    • : {{domxref("MessagePort")}} オブジェクトの配列で、メッセージが送信されるチャンネルに関連するポートを表します(チャンネルメッセージングや、共有ワーカーにメッセージを送信する場合など、適切な場合)。

この基本的な例では、サーバーからイベントを受け取るために EventSource を作成し、 sse.php という名前のページがイベントを作成する役割を担っています。

const evtSource = new EventSource("sse.php");
const eventList = document.querySelector("ul");

evtSource.addEventListener("message", (e) => {
  const newElement = document.createElement("li");

  newElement.textContent = `message: ${e.data}`;
  eventList.appendChild(newElement);
});

onmessage による同等品

evtSource.onmessage = (e) => {
  const newElement = document.createElement("li");

  newElement.textContent = `message: ${e.data}`;
  eventList.appendChild(newElement);
};

仕様書

{{Specifications}}

ブラウザーの互換性

{{Compat}}

関連情報