W3cubDocs

/Phoenix

Phoenix.LiveView.Socket

The LiveView socket for Phoenix Endpoints.

Summary

Types

assigns()
fingerprints()
t()

Functions

connect(params, socket, connect_info): Connects the Phoenix.Socket for a LiveView client.
id(socket): Identifies the Phoenix.Socket for a LiveView client.

Types

assigns()

Specs

assigns() :: map() | Phoenix.LiveView.Socket.AssignsNotInSocket.t()

fingerprints()

Specs

fingerprints() :: {nil, map()} | {binary(), map()}

t()

Specs

t() :: %Phoenix.LiveView.Socket{
  assigns: assigns(),
  changed: map(),
  connected?: boolean(),
  endpoint: module(),
  fingerprints: fingerprints(),
  host_uri: URI.t(),
  id: binary(),
  parent_pid: nil | pid(),
  private: map(),
  redirected: nil | tuple(),
  root_pid: pid(),
  root_view: module(),
  router: module(),
  view: module()
}

Functions

connect(params, socket, connect_info)

Connects the Phoenix.Socket for a LiveView client.

id(socket)

Identifies the Phoenix.Socket for a LiveView client.