EpochtalkServer.Models.Ban.html

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="x-ua-compatible" content="ie=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <meta name="generator" content="ExDoc v0.37.2">
    <meta name="project" content="epochtalk_server v0.1.0">


    <title>EpochtalkServer.Models.Ban — epochtalk_server v0.1.0</title>

    <link rel="stylesheet" href="dist/html-elixir-6X3L5KMG.css" />

    <script defer src="dist/sidebar_items-C8922E45.js"></script>
    <script defer src="docs_config.js"></script>
    <script defer src="dist/html-6XHBGSGW.js"></script>

  </head>
  <body>
    <script>(()=>{var t="ex_doc:settings",e="dark";var o="dark",s="light";var E="sidebar_state",n="closed";var r="sidebar_width";var a="sidebar-open";var i=new URLSearchParams(window.location.search),S=i.get("theme")||JSON.parse(localStorage.getItem(t)||"{}").theme;(S===o||S!==s&&window.matchMedia("(prefers-color-scheme: dark)").matches)&&document.body.classList.add(e);var d=sessionStorage.getItem(E),A=d!==n&&!window.matchMedia(`screen and (max-width: ${768}px)`).matches;document.body.classList.toggle(a,A);var c=sessionStorage.getItem(r);c&&document.body.style.setProperty("--sidebarWidth",`${c}px`);var p=/(Macintosh|iPhone|iPad|iPod)/.test(window.navigator.userAgent);document.documentElement.classList.toggle("apple-os",p);})();
</script>

<div class="body-wrapper">

<button id="sidebar-menu" class="sidebar-button sidebar-toggle" aria-label="toggle sidebar" aria-controls="sidebar">
  <i class="ri-menu-line ri-lg" title="Collapse/expand sidebar"></i>
</button>

<nav id="sidebar" class="sidebar">

  <div class="sidebar-header">
    <div class="sidebar-projectInfo">

      <div>
        <a href="api-reference.html" class="sidebar-projectName" translate="no">
epochtalk_server
        </a>
        <div class="sidebar-projectVersion" translate="no">
          v0.1.0
        </div>
      </div>
    </div>
    <ul id="sidebar-list-nav" class="sidebar-list-nav" role="tablist" data-extras=""></ul>
  </div>
</nav>

<output role="status" id="toast"></output>

<main class="content page-module" id="main" data-type="modules">
  <div id="content" class="content-inner">
    <div class="top-search">
      <div class="search-settings">
        <form class="search-bar" action="search.html">
          <label class="search-label">
            <span class="sr-only">Search documentation of epochtalk_server</span>
            <input name="q" type="text" class="search-input" placeholder="Press / to search" autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" />
          </label>
          <button type="submit" class="search-button" aria-label="Submit Search" tabindex="-1">
            <i class="ri-search-2-line ri-lg" aria-hidden="true"></i>
          </button>
          <button type="button" tabindex="-1" class="search-close-button" aria-hidden="true">
            <i class="ri-close-line ri-lg" title="Cancel search"></i>
          </button>
        </form>
        <div class="autocomplete">
        </div>
        <button class="icon-settings display-settings">
          <i class="ri-settings-3-line"></i>
          <span class="sr-only">Settings</span>
        </button>
      </div>
    </div>

<div id="top-content">
  <div class="heading-with-actions top-heading">
    <h1>
      <span translate="no">EpochtalkServer.Models.Ban</span> 
      <small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>

    </h1>

  </div>


    <section id="moduledoc">
<p><code class="inline">Ban</code> model, for performing actions relating to banning</p>
    </section>

</div>

  <section id="summary" class="details-list">
    <h1 class="section-heading">
      <a class="hover-link" href="#summary">
        <i class="ri-link-m" aria-hidden="true"></i>
      </a>
      <span class="text">Summary</span>
    </h1>
<div class="summary-types summary">
  <h2>
    <a href="#types">Types</a>
  </h2>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#t:t/0" data-no-tooltip="" translate="no">t()</a>

      </div>

    </div>

</div>
<div class="summary-functions summary">
  <h2>
    <a href="#functions">Functions</a>
  </h2>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#ban/1" data-no-tooltip="" translate="no">ban(user)</a>

      </div>

        <div class="summary-synopsis"><p>Used to ban a <code class="inline">User</code> permanently. Updates supplied <code class="inline">User</code> model to reflect ban and returns.</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#ban/2" data-no-tooltip="" translate="no">ban(user, expiration)</a>

      </div>

        <div class="summary-synopsis"><p>Used to ban a <code class="inline">User</code> until supplied <code class="inline">expiration</code>. Passing <code class="inline">nil</code> for <code class="inline">expiration</code> will
permanently ban the <code class="inline">User</code>. Updates supplied <code class="inline">User</code> model to reflect ban and returns.</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#ban_by_user_id/2" data-no-tooltip="" translate="no">ban_by_user_id(user_id, expiration)</a>

      </div>

        <div class="summary-synopsis"><p>Used to ban a <code class="inline">User</code> by <code class="inline">user_id</code> until supplied <code class="inline">expiration</code>. Passing <code class="inline">nil</code> for <code class="inline">expiration</code> will
permanently ban the <code class="inline">User</code></p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#ban_changeset/2" data-no-tooltip="" translate="no">ban_changeset(ban, attrs \\ %{})</a>

      </div>

        <div class="summary-synopsis"><p>Create ban changeset for <code class="inline">Ban</code> model, handles upsert of ban for banning</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#by_user_id/1" data-no-tooltip="" translate="no">by_user_id(user_id)</a>

      </div>

        <div class="summary-synopsis"><p>Fetches <code class="inline">Ban</code> associated with a specific <code class="inline">User</code></p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#changeset/2" data-no-tooltip="" translate="no">changeset(ban, attrs \\ %{})</a>

      </div>

        <div class="summary-synopsis"><p>Create generic changeset for <code class="inline">Ban</code> model</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#unban/1" data-no-tooltip="" translate="no">unban(user)</a>

      </div>

        <div class="summary-synopsis"><p>Used to unban a <code class="inline">User</code>. Updates supplied <code class="inline">User</code> model to reflect unbanning and returns.</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#unban_by_user_id/1" data-no-tooltip="" translate="no">unban_by_user_id(user_id)</a>

      </div>

        <div class="summary-synopsis"><p>Used to unban a <code class="inline">User</code> by <code class="inline">user_id</code>. Will return <code class="inline">{:ok, nil}</code> if user was never banned.</p></div>

    </div>

    <div class="summary-row">
      <div class="summary-signature">
        <a href="#unban_changeset/2" data-no-tooltip="" translate="no">unban_changeset(ban, attrs \\ %{})</a>

      </div>

        <div class="summary-synopsis"><p>Create unban changeset for <code class="inline">Ban</code> model, handles update of ban for unbanning</p></div>

    </div>

</div>

  </section>


  <section id="types" class="details-list">
    <h1 class="section-heading">
      <a class="hover-link" href="#types">
        <i class="ri-link-m" aria-hidden="true"></i>
      </a>
      <span class="text">Types</span>
    </h1>
    <div class="types-list">
<section class="detail" id="t:t/0">

  <div class="detail-header">
    <a href="#t:t/0" class="detail-link" data-no-tooltip="" aria-label="Link to this type">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">t()</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@type</span> t() :: %EpochtalkServer.Models.Ban{
  __meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
  created_at: <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>() | nil,
  expiration: <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>() | nil,
  id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
  updated_at: <a href="https://hexdocs.pm/elixir/NaiveDateTime.html#t:t/0">NaiveDateTime.t</a>() | nil,
  user: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
  user_id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil
}</pre>

      </div>


  </section>
</section>

    </div>
  </section>

  <section id="functions" class="details-list">
    <h1 class="section-heading">
      <a class="hover-link" href="#functions">
        <i class="ri-link-m" aria-hidden="true"></i>
      </a>
      <span class="text">Functions</span>
    </h1>
    <div class="functions-list">
<section class="detail" id="ban/1">

  <div class="detail-header">
    <a href="#ban/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">ban(user)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> ban(user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()) ::
  {:ok, user_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()} | {:error, :ban_error}</pre>

      </div>

<p>Used to ban a <code class="inline">User</code> permanently. Updates supplied <code class="inline">User</code> model to reflect ban and returns.</p>
  </section>
</section>
<section class="detail" id="ban/2">

  <div class="detail-header">
    <a href="#ban/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">ban(user, expiration)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> ban(
  user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>(),
  expiration :: <a href="https://hexdocs.pm/elixir/Calendar.html#t:naive_datetime/0">Calendar.naive_datetime</a>() | nil
) :: {:ok, user_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()} | {:error, :ban_error}</pre>

      </div>

<p>Used to ban a <code class="inline">User</code> until supplied <code class="inline">expiration</code>. Passing <code class="inline">nil</code> for <code class="inline">expiration</code> will
permanently ban the <code class="inline">User</code>. Updates supplied <code class="inline">User</code> model to reflect ban and returns.</p>
  </section>
</section>
<section class="detail" id="ban_by_user_id/2">

  <div class="detail-header">
    <a href="#ban_by_user_id/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">ban_by_user_id(user_id, expiration)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> ban_by_user_id(
  user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>(),
  expiration :: <a href="https://hexdocs.pm/elixir/Calendar.html#t:naive_datetime/0">Calendar.naive_datetime</a>() | nil
) :: {:ok, ban_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()} | {:error, :ban_error}</pre>

      </div>

<p>Used to ban a <code class="inline">User</code> by <code class="inline">user_id</code> until supplied <code class="inline">expiration</code>. Passing <code class="inline">nil</code> for <code class="inline">expiration</code> will
permanently ban the <code class="inline">User</code></p>
  </section>
</section>
<section class="detail" id="ban_changeset/2">

    <span id="ban_changeset/1"></span>

  <div class="detail-header">
    <a href="#ban_changeset/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">ban_changeset(ban, attrs \\ %{})</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> ban_changeset(ban :: <a href="#t:t/0">t</a>(), attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | nil) :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre>

      </div>

<p>Create ban changeset for <code class="inline">Ban</code> model, handles upsert of ban for banning</p>
  </section>
</section>
<section class="detail" id="by_user_id/1">

  <div class="detail-header">
    <a href="#by_user_id/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">by_user_id(user_id)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> by_user_id(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) ::
  {:ok, ban_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()}
  | {:error, ban_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()}</pre>

      </div>

<p>Fetches <code class="inline">Ban</code> associated with a specific <code class="inline">User</code></p>
  </section>
</section>
<section class="detail" id="changeset/2">

    <span id="changeset/1"></span>

  <div class="detail-header">
    <a href="#changeset/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">changeset(ban, attrs \\ %{})</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> changeset(ban :: <a href="#t:t/0">t</a>(), attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | nil) :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre>

      </div>

<p>Create generic changeset for <code class="inline">Ban</code> model</p>
  </section>
</section>
<section class="detail" id="unban/1">

  <div class="detail-header">
    <a href="#unban/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">unban(user)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> unban(user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()) ::
  {:ok, user :: <a href="EpochtalkServer.Models.User.html#t:t/0">EpochtalkServer.Models.User.t</a>()} | {:error, :unban_error}</pre>

      </div>

<p>Used to unban a <code class="inline">User</code>. Updates supplied <code class="inline">User</code> model to reflect unbanning and returns.</p>
  </section>
</section>
<section class="detail" id="unban_by_user_id/1">

  <div class="detail-header">
    <a href="#unban_by_user_id/1" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">unban_by_user_id(user_id)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> unban_by_user_id(user_id :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">integer</a>()) ::
  {:ok, ban_changeset :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()}
  | {:ok, nil}
  | {:error, :unban_error}</pre>

      </div>

<p>Used to unban a <code class="inline">User</code> by <code class="inline">user_id</code>. Will return <code class="inline">{:ok, nil}</code> if user was never banned.</p>
  </section>
</section>
<section class="detail" id="unban_changeset/2">

    <span id="unban_changeset/1"></span>

  <div class="detail-header">
    <a href="#unban_changeset/2" class="detail-link" data-no-tooltip="" aria-label="Link to this function">
      <i class="ri-link-m" aria-hidden="true"></i>
    </a>
    <div class="heading-with-actions">
      <h1 class="signature" translate="no">unban_changeset(ban, attrs \\ %{})</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> unban_changeset(ban :: <a href="#t:t/0">t</a>(), attrs :: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | nil) :: <a href="https://hexdocs.pm/ecto/3.12.5/Ecto.Changeset.html#t:t/0">Ecto.Changeset.t</a>()</pre>

      </div>

<p>Create unban changeset for <code class="inline">Ban</code> model, handles update of ban for unbanning</p>
  </section>
</section>

    </div>
  </section>

    <footer class="footer">
      <p>

        <span class="line">
          <button class="a-main footer-button display-quick-switch" title="Search HexDocs packages">
            Search HexDocs
          </button>

            <a href="epochtalk_server.epub" title="ePub version">
              Download ePub version
            </a>

        </span>
      </p>

      <p class="built-using">
        Built using
        <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" target="_blank" rel="help noopener" translate="no">ExDoc</a> (v0.37.2) for the

          <a href="https://elixir-lang.org" title="Elixir" target="_blank" translate="no">Elixir programming language</a>

      </p>

    </footer>
  </div>
</main>
</div>

  </body>
</html>