Search documentation of Phoenix

# Phoenix.Socket.Reply (Phoenix v1.8.7)

View Source

Defines a reply sent from channels to transports.

The message format requires the following keys:

- `:topic` - The string topic or topic:subtopic pair namespace, for example "messages", "messages:123"
- `:status` - The reply status as an atom
- `:payload` - The reply payload
- `:ref` - The unique string ref
- `:join_ref` - The unique string ref when joining

## Summary

### Types

t()

## Types

# t()

    @type t() :: %Phoenix.Socket.Reply{
      join_ref: term(),
      payload: term(),
      ref: term(),
      status: term(),
      topic: term()
    }