ExClubhouse v0.5.2 ExClubhouse.Api.Group View Source
Simple interface to the Group API
Link to this section Summary
Link to this section Functions
Link to this function
create(group_input)
View Sourcecreate(ExClubhouse.Model.Input.Group.t()) :: {:ok, ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}
Create a group
Example
iex> ExClubhouse.Api.Group.update(ExClubhouse.Model.Input.Group{...})
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function
create(session, group_input)
View Sourcecreate(ExClubhouse.Session.t(), ExClubhouse.Model.Input.Group.t()) :: {:ok, ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}
Link to this function
get(group_public_id)
View Sourceget(binary()) :: {:ok, nil | ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}
Get a single group by id
Example
iex> ExClubhouse.Api.Group.get(1)
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function
get(session, group_public_id)
View Sourceget(ExClubhouse.Session.t(), binary()) :: {:ok, ExClubhouse.Model.Group.t() | nil} | {:error, ExClubhouse.Error.t()}
Link to this function
list()
View Sourcelist() :: {:ok, [ExClubhouse.Model.Group.t()]} | {:error, ExClubhouse.Error.t()}
Lists all groups
Example
iex> ExClubhouse.Api.Group.list()
{:ok, [%ExClubhouse.Model.Group{...}, ...]}
Link to this function
list(sess)
View Sourcelist(ExClubhouse.Session.t()) :: {:ok, [ExClubhouse.Model.Group.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function
update(group_public_id, group_input)
View Sourceupdate(binary(), ExClubhouse.Model.Input.Group.t()) :: {:ok, ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}
Update a group
Example
iex> ExClubhouse.Api.File.upfate(ExClubhouse.Model.Input.Group{...})
{:ok, %ExClubhouse.Model.Group{...}}
Link to this function
update(session, group_public_id, group_input)
View Sourceupdate(ExClubhouse.Session.t(), binary(), ExClubhouse.Model.Input.Group.t()) :: {:ok, ExClubhouse.Model.Group.t()} | {:error, ExClubhouse.Error.t()}