epochtalk_server v0.1.0

EpochtalkServer.Models.Mention (epochtalk_server v0.1.0)

Mention model, for performing actions relating to forum categories

Link to this section Summary

Types

t()

Functions

changeset(mention, attrs)

Create generic changeset for Mention model

page_by_user_id(user_id, page \\ 1, opts \\ [])

Page Mention models by for a specific User

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.Mention{
  __meta__: term(),
  created_at: NaiveDateTime.t() | nil,
  id: non_neg_integer() | nil,
  mentionee: term(),
  mentionee_id: non_neg_integer() | nil,
  mentioner: term(),
  mentioner_id: non_neg_integer() | nil,
  notification_id: term(),
  post: term(),
  post_id: non_neg_integer() | nil,
  thread: term(),
  thread_id: non_neg_integer() | nil,
  viewed: term()
}

Link to this section Functions

Link to this function

changeset(mention, attrs)

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

Create generic changeset for Mention model

Link to this function

page_by_user_id(user_id, page \\ 1, opts \\ [])

@spec page_by_user_id(user_id :: non_neg_integer(), page :: non_neg_integer(),
  per_page: non_neg_integer(),
  extended: boolean()
) :: {:ok, mentions :: [t()] | [], pagination_data :: map()}

Page Mention models by for a specific User

valid-options

 Valid Options

nametypedetails
:per_pagenon_neg_integerrecords per page to return
:extendedbooleanreturns board and post details with mention if true