ExClubhouse v0.6.0 ExClubhouse.Api.Member View Source

Member Api

Link to this section Summary

Link to this section Functions

Link to this function

current_member_info()

View Source
current_member_info() ::
  {:ok, ExClubhouse.Model.MemberInfo.t()} | {:error, ExClubhouse.Error.t()}

Gets the current member info

Example

iex> ExClubhouse.Api.Member.current_member_info()
{:ok, %ExClubhouse.Model.MemberInfo{...}}
Link to this function

current_member_info(session)

View Source
current_member_info(ExClubhouse.Session.t()) ::
  {:ok, [ExClubhouse.Model.MemberInfo.t()]} | {:error, ExClubhouse.Error.t()}
Link to this function

get(org_public_id, member_public_id)

View Source
get(binary(), binary()) ::
  {:ok, ExClubhouse.Model.Member.t() | nil} | {:error, ExClubhouse.Error.t()}

Get a single LinkedFile by id

Example

iex> ExClubhouse.Api.Member.get("1", "2")
{:ok, %ExClubhouse.Model.Member{...}}
Link to this function

get(session, org_public_id, member_public_id)

View Source
Link to this function

list(org_public_id)

View Source
list(binary()) ::
  {:ok, [ExClubhouse.Model.Member.t()]} | {:error, ExClubhouse.Error.t()}

Lists all members

Example

iex> ExClubhouse.Api.Member.list()
{:ok, [%ExClubhouse.Model.Member{...}, ...]}