EpochtalkServer.Models.Configuration.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.Configuration — 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.Configuration</span> 
      <small class="app-vsn" translate="no">(epochtalk_server v0.1.0)</small>

    </h1>

  </div>


    <section id="moduledoc">
<p><code class="inline">Configuration</code> model, for performing actions relating to frontend <code class="inline">Configuration</code></p><p>WARNING: ensure all keys are atoms when storing via Application.put_env
use <code class="inline">atomize_keys/2</code> when necessary</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="#by_name/1" data-no-tooltip="" translate="no">by_name(name)</a>

      </div>

        <div class="summary-synopsis"><p>Gets a <code class="inline">Configuration</code> from the database by <code class="inline">name</code></p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Creates a new <code class="inline">Configuration</code> into the database</p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Create changeset for creating a new <code class="inline">Configuration</code> model</p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Deletes <code class="inline">Configuration</code> from database</p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Gets default frontend <code class="inline">Configuration</code> from the database</p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Inserts a default <code class="inline">Configuration</code> into the database given <code class="inline">config_map</code></p></div>

    </div>

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

      </div>

        <div class="summary-synopsis"><p>Warms <code class="inline">:epochtalk_server[:frontend_config]</code> config variable using <code class="inline">Configuration</code> stored in database,
if present. If there is no <code class="inline">Configuration</code> in the database, the default value is taken
from <code class="inline">:epochtalk_server[:frontend_config]</code> and inserted into the database as the default
<code class="inline">Configuration</code>. Run as a Task on application startup.</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.Configuration{
  __meta__: <a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>(),
  config: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">map</a>() | nil,
  id: <a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>() | nil,
  name: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</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="by_name/1">

  <div class="detail-header">
    <a href="#by_name/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_name(name)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> by_name(name :: <a href="https://hexdocs.pm/elixir/String.html#t:t/0">String.t</a>()) :: <a href="#t:t/0">t</a>() | nil</pre>

      </div>

<p>Gets a <code class="inline">Configuration</code> from the database by <code class="inline">name</code></p>
  </section>
</section>
<section class="detail" id="create/1">

  <div class="detail-header">
    <a href="#create/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">create(configuration)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

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

      </div>

<p>Creates a new <code class="inline">Configuration</code> into the database</p>
  </section>
</section>
<section class="detail" id="create_changeset/2">

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

  <div class="detail-header">
    <a href="#create_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">create_changeset(configuration, attrs \\ %{})</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> create_changeset(
  configuration :: <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 changeset for creating a new <code class="inline">Configuration</code> model</p>
  </section>
</section>
<section class="detail" id="delete/0">

  <div class="detail-header">
    <a href="#delete/0" 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">delete()</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> delete() :: {<a href="https://hexdocs.pm/elixir/typespecs.html#basic-types">non_neg_integer</a>(), nil | [<a href="https://hexdocs.pm/elixir/typespecs.html#built-in-types">term</a>()]}</pre>

      </div>

<p>Deletes <code class="inline">Configuration</code> from database</p>
  </section>
</section>
<section class="detail" id="get_default/0">

  <div class="detail-header">
    <a href="#get_default/0" 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">get_default()</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> get_default() :: <a href="#t:t/0">t</a>() | nil</pre>

      </div>

<p>Gets default frontend <code class="inline">Configuration</code> from the database</p>
  </section>
</section>
<section class="detail" id="set_default/1">

  <div class="detail-header">
    <a href="#set_default/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">set_default(config_map)</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

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

      </div>

<p>Inserts a default <code class="inline">Configuration</code> into the database given <code class="inline">config_map</code></p>
  </section>
</section>
<section class="detail" id="warm_frontend_config/0">

  <div class="detail-header">
    <a href="#warm_frontend_config/0" 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">warm_frontend_config()</h1>


    </div>
  </div>

  <section class="docstring">

      <div class="specs">

          <pre translate="no"><span class="attribute">@spec</span> warm_frontend_config() :: :ok</pre>

      </div>

<p>Warms <code class="inline">:epochtalk_server[:frontend_config]</code> config variable using <code class="inline">Configuration</code> stored in database,
if present. If there is no <code class="inline">Configuration</code> in the database, the default value is taken
from <code class="inline">:epochtalk_server[:frontend_config]</code> and inserted into the database as the default
<code class="inline">Configuration</code>. Run as a Task on application startup.</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>