CodeCorps.User.html

    <!DOCTYPE html>
<html>
  <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.13.2">
    <title>CodeCorps.User – code_corps v0.0.1</title>
    <link rel="stylesheet" href="dist/app-bbdf358507.css" />
    
    <script src="dist/sidebar_items.js"></script>
  </head>
  <body data-type="modules">
    <script>if(localStorage.getItem('night-mode')) document.body.className += ' night-mode';</script>

    <div class="main">
<button class="sidebar-toggle">
  <i class="icon-menu"></i>
</button>
<section class="sidebar">

  
  <a href="api-reference.html" class="sidebar-projectLink">
    <div class="sidebar-projectDetails">
      <h1 class="sidebar-projectName">
        code_corps
      </h1>
      <h2 class="sidebar-projectVersion">
        v0.0.1
      </h2>
    </div>
    
  </a>

  <div class="sidebar-search">
    <i class="icon-search"></i>
    <input type="text" class="sidebar-searchInput" placeholder="search" autocomplete="off" />
  </div>

  <ul class="sidebar-listNav">
    <li><a id="extras-list" href="#full-list">Pages</a></li>

    
      <li><a id="modules-list" href="#full-list">Modules</a></li>
    

  </ul>

  <ul id="full-list" class="sidebar-fullList"></ul>
  <div class="sidebar-noResults"></div>
</section>

<section class="content">
  <div class="content-outer">
    <div id="content" class="content-inner">


      <h1>
        <small class="visible-xs">code_corps v0.0.1</small>
        CodeCorps.User
        
        
      </h1>

      
        <section id="moduledoc">
          <p>This module defines a user of the Code Corps app.</p>

        </section>
      

        <section id="summary" class="details-list">
          <h1 class="section-heading">
            <a class="hover-link" href="#summary">
              <i class="icon-link"></i>
            </a>
            Summary
          </h1>
          

  <div class="summary-functions summary">
    <h2>
      <a href="#functions">Functions</a>
    </h2>
    <div class="summary-row">
  <div class="summary-signature">
    <a href="#apply_state_transition/2">apply_state_transition(changeset, map)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#changeset/2">changeset(struct, params \\ %{})</a>
  </div>
  
    <div class="summary-synopsis"><p>Builds a changeset based on the <code class="inline">struct</code> and <code class="inline">params</code></p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#check_email_availability/1">check_email_availability(email)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#check_username_availability/1">check_username_availability(username)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#index_filters/2">index_filters(query, params)</a>
  </div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#registration_changeset/2">registration_changeset(struct, params)</a>
  </div>
  
    <div class="summary-synopsis"><p>Builds a changeset for registering the user</p>
</div>
  
</div>
<div class="summary-row">
  <div class="summary-signature">
    <a href="#update_changeset/2">update_changeset(struct, params)</a>
  </div>
  
</div>

  </div>


        </section>
      

        <section id="functions" class="details-list">
          <h1 class="section-heading">
            <a class="hover-link" href="#functions">
              <i class="icon-link"></i>
            </a>
            Functions
          </h1>
          <div class="detail" id="apply_state_transition/2">
  <div class="detail-header">
    <a href="#apply_state_transition/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">apply_state_transition(changeset, map)</span>
    
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="changeset/2">
  <div class="detail-header">
    <a href="#changeset/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">changeset(struct, params \\ %{})</span>
    
    
  </div>
  
  <section class="docstring">
    <p>Builds a changeset based on the <code class="inline">struct</code> and <code class="inline">params</code>.</p>

  </section>
</div>
<div class="detail" id="check_email_availability/1">
  <div class="detail-header">
    <a href="#check_email_availability/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">check_email_availability(email)</span>
    
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="check_username_availability/1">
  <div class="detail-header">
    <a href="#check_username_availability/1" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">check_username_availability(username)</span>
    
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="index_filters/2">
  <div class="detail-header">
    <a href="#index_filters/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">index_filters(query, params)</span>
    
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>
<div class="detail" id="registration_changeset/2">
  <div class="detail-header">
    <a href="#registration_changeset/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">registration_changeset(struct, params)</span>
    
    
  </div>
  
  <section class="docstring">
    <p>Builds a changeset for registering the user.</p>

  </section>
</div>
<div class="detail" id="update_changeset/2">
  <div class="detail-header">
    <a href="#update_changeset/2" class="detail-link" title="Link to this function">
      <i class="icon-link"></i>
    </a>
    <span class="signature">update_changeset(struct, params)</span>
    
    
  </div>
  
  <section class="docstring">
    
  </section>
</div>

        </section>
      

          <footer class="footer">
        <p>
          <span class="line">
            Built using
            <a href="https://github.com/elixir-lang/ex_doc" title="ExDoc" rel="help" target="_blank">ExDoc</a> (v0.13.2),
          </span>
          <span class="line">
            designed by
            <a href="https://twitter.com/dignifiedquire" target="_blank" title="@dignifiedquire">Friedel Ziegelmayer</a>.
            </span>
        </p>
        <button class="night-mode-toggle" />
      </footer>
    </div>
  </div>
</section>
</div>
  <script src="dist/app-9b2d1e432c.js"></script>
  </body>
</html>