epochtalk_server v0.1.0

EpochtalkServer.Models.BoardMapping (epochtalk_server v0.1.0)

BoardMapping model, for performing actions relating to mapping forum boards and categories

Link to this section Summary

Types

t()

Functions

changeset(board_mapping, attrs)

Create generic changeset for BoardMapping model

delete_board_by_id(id)

Deletes a Board from the BoardMapping

update(board_mapping_list)

Updates BoardMapping in the database

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.BoardMapping{
  __meta__: term(),
  board: EpochtalkServer.Models.Board.t() | term(),
  board_id: term(),
  category: EpochtalkServer.Models.Category.t() | term(),
  category_id: term(),
  parent: EpochtalkServer.Models.Board.t() | term(),
  parent_id: term(),
  view_order: non_neg_integer() | nil
}

Link to this section Functions

Link to this function

changeset(board_mapping, attrs)

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

Create generic changeset for BoardMapping model

Link to this function

delete_board_by_id(id)

@spec delete_board_by_id(board_id :: integer()) :: {non_neg_integer(), nil | [term()]}

Deletes a Board from the BoardMapping

Link to this function

update(board_mapping_list)

@spec update(board_mapping_list :: [%{}]) ::
  {:ok, Ecto.Changeset.t()} | {:error, Ecto.Changeset.t()} | {:error, any()}

Updates BoardMapping in the database