Kino
Kino
v0.12.3

View Source Kino.JS.Live.Context (Kino v0.12.3)

State available in Kino.JS.Live server callbacks.

properties

 Properties

Link to this section Summary

Types

origin()
t()

Functions

assign(ctx, assigns)

Stores key-value pairs in the state.

broadcast_event(ctx, event, payload \\ nil)

Sends an event to all clients.

emit_event(ctx, event)

Emits an event to processes subscribed to this kino.

send_event(ctx, client_id, event, payload \\ nil)

Sends an event to a specific client.

update(ctx, key, fun)

Updates an existing key with the given function in the state.

Link to this section Types

Link to this type

origin()

View Source 
@type origin() :: nil | term()
Link to this type

t()

View Source 
@type t() :: %Kino.JS.Live.Context{
  __private__: map(),
  assigns: map(),
  origin: origin()
}

Link to this section Functions

Link to this function

assign(ctx, assigns)

View Source 
@spec assign(t(), Enumerable.t()) :: t()

Stores key-value pairs in the state.

examples

 Examples 

assign(ctx, count: 1, timestamp: DateTime.utc_now())
Link to this function

broadcast_event(ctx, event, payload \\ nil)

View Source 
@spec broadcast_event(t(), String.t(), term()) :: :ok

Sends an event to all clients.

The event is dispatched to the registered JavaScript callback on all connected clients.

examples

 Examples 

broadcast_event(ctx, "new_point", %{x: 10, y: 10})
Link to this function

emit_event(ctx, event)

View Source 
@spec emit_event(t(), term()) :: :ok

Emits an event to processes subscribed to this kino.

Consumers may subscribe to events emitted by the given instance of Kino.JS.Live using functions in the Kino.Control module, such as Kino.Control.stream/1.

examples

 Examples 

emit_event(ctx, %{event: :click, counter: 1})
Link to this function

send_event(ctx, client_id, event, payload \\ nil)

View Source 
@spec send_event(t(), term(), String.t(), term()) :: :ok

Sends an event to a specific client.

The event is dispatched to the registered JavaScript callback on the specific connected client.

examples

 Examples 

send_event(ctx, origin, "new_point", %{x: 10, y: 10})
Link to this function

update(ctx, key, fun)

View Source 
@spec update(t(), term(), (term() -> term())) :: t()

Updates an existing key with the given function in the state.

examples

 Examples 

update(ctx, :count, &(&1 + 1))