epochtalk_server v0.1.0

EpochtalkServer.Models.Invitation (epochtalk_server v0.1.0)

Invitation model, for performing actions relating to inviting new users to the forum

Link to this section Summary

Types

t()

Functions

create(email)

Creates a new Invitation in the database

create_changeset(invitation, attrs \\ %{})

Create changeset for inserting a new Invitation model

delete(email)

Deletes Invitation from the database by email

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.Invitation{
  __meta__: term(),
  created_at: NaiveDateTime.t() | nil,
  email: String.t() | nil,
  hash: String.t() | nil
}

Link to this section Functions

Link to this function

create(email)

@spec create(email :: String.t()) ::
  {:ok, invitation :: t()} | {:error, Ecto.Changeset.t()}

Creates a new Invitation in the database

Link to this function

create_changeset(invitation, attrs \\ %{})

@spec create_changeset(invitation :: t(), attrs :: map() | nil) :: Ecto.Changeset.t()

Create changeset for inserting a new Invitation model

Link to this function

delete(email)

@spec delete(email :: String.t()) :: {non_neg_integer(), nil | [term()]}

Deletes Invitation from the database by email