Phoenix v0.11.0 → Overview → Phoenix → Socket → Message

Phoenix.Socket.Message

Defines a Phoenix.Socket Message dispatched over channels.

The Message format requires the following keys:

topic - The string topic or topic:subtopic pair namespace, ie “messages”, “messages:123”
event- The string event name, ie “phx_join”
payload - The string JSON message payload
ref - The unique string ref

Source

Summary↑

Converts a map with string keys into a %Phoenix.Socket.Message{}. Raises Phoenix.Socket.Message.InvalidMessage if not valid

from_map!(map)

(function) # ↑

Converts a map with string keys into a %Phoenix.Socket.Message{}. Raises Phoenix.Socket.Message.InvalidMessage if not valid.

Source