View Source Phoenix.Socket.Broadcast (Phoenix v1.7.0-rc.0)

Defines a message sent from pubsub to channels and vice-versa.

The message format requires the following keys:

:topic - The string topic or topic:subtopic pair namespace, for example "messages", "messages:123"
:event- The string event name, for example "phx_join"
:payload - The message payload

Link to this section Summary

Types

t()

Link to this section Types

t()

@type t() :: %Phoenix.Socket.Broadcast{event: term(), payload: term(), topic: term()}