AbsintheClient.WebSocket.Reply (AbsintheClient v0.2.0)

View Source

Reply sent from GraphQL servers to clients in response to a pushed document.

The message format requires the following keys:

  • :event - The string event name that was pushed, for example "doc".

  • :status - The reply status as an atom.

  • :payload - The reply payload.

  • :ref - A unique term defined by the user when pushing or nil if none was provided.

  • :push_ref - The unique ref ref when pushing.

Summary

Types

t()

Types

t()

@type t() :: %AbsintheClient.WebSocket.Reply{
  event: term(),
  payload: term(),
  push_ref: term(),
  ref: term(),
  status: term()
}