epochtalk_server v0.1.0

EpochtalkServer.Models.Board (epochtalk_server v0.1.0)

Board model, for performing actions relating to forum boards

Link to this section Summary

Types

t()

Functions

changeset(board, attrs)

Create generic changeset for Board model

create(board)

Creates a new Board in the database

create_changeset(board, attrs)

Create changeset for creation of Board model

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.Board{
  __meta__: term(),
  category: EpochtalkServer.Models.Category.t() | term(),
  created_at: NaiveDateTime.t() | nil,
  description: String.t() | nil,
  id: non_neg_integer() | nil,
  imported_at: NaiveDateTime.t() | nil,
  meta: map() | nil,
  name: String.t() | nil,
  post_count: non_neg_integer() | nil,
  postable_by: non_neg_integer() | nil,
  right_to_left: boolean() | nil,
  slug: String.t() | nil,
  thread_count: non_neg_integer() | nil,
  updated_at: term(),
  viewable_by: non_neg_integer() | nil
}

Link to this section Functions

Link to this function

changeset(board, attrs)

@spec changeset(
  board :: t(),
  attrs :: map() | nil
) :: Ecto.Changeset.t()

Create generic changeset for Board model

Link to this function

create(board)

@spec create(board_attrs :: map()) ::
  {:ok, board :: t()} | {:error, Ecto.Changeset.t()}

Creates a new Board in the database

Link to this function

create_changeset(board, attrs)

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

Create changeset for creation of Board model