CPub v0.3.0

CPub.User (CPub v0.3.0) View Source

A CPub user.

Link to this section Summary

Types

t()

Functions

create(username)
create!(username)
get(username)

Get a single user by username.

get_by_id(id)

Get a single user by id.

get_profile(user)

Get the user profile

Link to this section Types

Link to this type

t()

View Source

Specs

t() :: %CPub.User{
  __meta__: term(),
  followers: RDF.IRI.t(),
  following: RDF.IRI.t(),
  id: String.t(),
  inbox: RDF.IRI.t(),
  outbox: RDF.IRI.t(),
  profile: RDF.FragmentGraph.t(),
  username: String.t()
}

Link to this section Functions

Link to this function

create(username)

View Source

Specs

create(String.t()) :: {:ok, t()} | {:error, any()}
Link to this function

create!(username)

View Source

Specs

create!(String.t()) :: t()
Link to this function

get(username)

View Source

Specs

get(String.t()) :: {:ok, t()} | {:error, any()}

Get a single user by username.

Link to this function

get_by_id(id)

View Source

Specs

get_by_id(String.t()) :: {:ok, t()} | {:error, any()}

Get a single user by id.

Link to this function

get_profile(user)

View Source

Specs

get_profile(t()) :: RDF.FragmentGraph.t()

Get the user profile