Vik.Presence (Vik v0.0.1-rc1)
View SourceEnables live awareness features in collaborative contexts.
Summary
Functions
Counts the amount of active participants in a session.
Callback implementation for Phoenix.Presence.get_by_key/2
.
Callback implementation for Phoenix.Presence.list/1
.
Returns a list of all active participants in a session.
Subscribes to room join/leaves.
Callback implementation for Phoenix.Presence.track/3
.
Callback implementation for Phoenix.Presence.track/4
.
Unsubscribes from room join/leaves.
Callback implementation for Phoenix.Presence.untrack/2
.
Callback implementation for Phoenix.Presence.untrack/3
.
Callback implementation for Phoenix.Presence.update/3
.
Callback implementation for Phoenix.Presence.update/4
.
Functions
@spec count_participants(Vik.Authority.suid()) :: :ok | :error
Counts the amount of active participants in a session.
Callback implementation for Phoenix.Presence.get_by_key/2
.
Callback implementation for Phoenix.Presence.list/1
.
@spec list_participants(Vik.Authority.suid()) :: :ok | :error
Returns a list of all active participants in a session.
@spec subscribe(Vik.Authority.suid()) :: :ok | :error
@spec subscribe(Vik.Authority.suid()) :: :ok | :error
Subscribes to room join/leaves.
Message format
{:join, suid, ~m{id, name, metas}}
{:leave, suid, ~m{id, name, metas}}
Callback implementation for Phoenix.Presence.track/3
.
Callback implementation for Phoenix.Presence.track/4
.
Unsubscribes from room join/leaves.
Callback implementation for Phoenix.Presence.untrack/2
.
Callback implementation for Phoenix.Presence.untrack/3
.
Callback implementation for Phoenix.Presence.update/3
.
Callback implementation for Phoenix.Presence.update/4
.