epochtalk_server v0.1.0

EpochtalkServer.Models.Preference (epochtalk_server v0.1.0)

Preference model, for performing actions relating to a user's preferences

Link to this section Summary

Types

t()

Functions

by_user_id(user_id)

Fetches Preference associated with a specific User

changeset(preference, attrs \\ %{})

Creates a generic changeset for Preference model

Link to this section Types

Link to this type

t()

@type t() :: %EpochtalkServer.Models.Preference{
  __meta__: term(),
  collapsed_categories: %{} | nil,
  email_mentions: boolean() | nil,
  email_messages: boolean() | nil,
  ignore_newbies: boolean() | nil,
  ignored_boards: %{} | nil,
  notify_replied_threads: boolean() | nil,
  patroller_view: boolean() | nil,
  posts_per_page: non_neg_integer() | nil,
  threads_per_page: non_neg_integer() | nil,
  timezone_offset: String.t() | nil,
  user: term(),
  user_id: non_neg_integer() | nil
}

Link to this section Functions

Link to this function

by_user_id(user_id)

@spec by_user_id(user_id :: integer()) ::
  {:ok, preference_changeset :: Ecto.Changeset.t()}
  | {:error, preference_changeset :: Ecto.Changeset.t()}

Fetches Preference associated with a specific User

Link to this function

changeset(preference, attrs \\ %{})

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

Creates a generic changeset for Preference model