Blur v0.2.1-beta3 Blur.Users View Source

Manages the lists of users in each channel.

Link to this section Summary

Functions

Returns a specification to start this module under a supervisor.

Get users

Link to this section Functions

Specs

add_user(
  pid :: GenServer.server(),
  user :: %Blur.User{name: term(), opts: term()}
) :: :ok

Add user

Returns a specification to start this module under a supervisor.

See Supervisor.

Specs

find_user(
  pid :: GenServer.server(),
  user :: %Blur.User{name: term(), opts: term()}
) :: %Blur.User{name: term(), opts: term()}

Get user

Specs

remove_user(
  pid :: GenServer.server(),
  user :: %Blur.User{name: term(), opts: term()}
) :: :ok

Remove user

Specs

start_link(users :: list()) :: GenServer.on_start()

Specs

users(pid :: GenServer.server()) :: list() | {:error, atom()}

Get users