docs/api/backend/Users.schema.html

<!DOCTYPE html>
<html lang="en">

<head>
  
  <meta charset="utf-8">
  <meta name="viewport" content="width=device-width, initial-scale=1">
  <title>lea.online App-Backend Documentation schema</title>

  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
  <script src="./build/entry.js"></script>
  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
  <!--[if lt IE 9]>
    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
  <![endif]-->
  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
  <link type="text/css" rel="stylesheet" href="">
  <script async defer src="https://buttons.github.io/buttons.js"></script>

  
</head>


<body class="layout small-header">
    <div id="stickyNavbarOverlay"></div>
    

<div class="top-nav">
    <div class="inner">
        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
            <span aria-hidden="true"></span>
        </a>
        <div class="logo">
            
             
                <a href="index.html">
                    <h1 class="navbar-item">lea.online App-Backend Documentation</h1>
                </a>
            
        </div>
        <div class="menu">
            
            <div class="navigation">
                <a
                    href="index.html"
                    class="link"
                >
                    Documentation
                </a>
                
                 
                        <a
                            class="link user-link "
                            href="https://github.com/leaonline/leaonline-app"
                        >
                            Github
                        </a>
                    
                
            </div>
        </div>
    </div>
</div>
    <div id="main">
        <div
            class="sidebar "
            id="sidebarNav"
        >
            
                <div class="search-wrapper">
                    <input id="search" type="text" placeholder="Search docs..." class="input">
                </div>
            
            <nav>
                
                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Modules</h3><ul><li><a href="module-onServerExec.html">onServerExec</a></li></ul><h3>Namespaces</h3><ul><li><a href="Session.methods.html">methods</a></li><li><a href="Session.schema.html">schema</a></li></ul><h3>Classes</h3><ul><li><a href="Repository.html">Repository</a></li></ul><h3>Global</h3><ul><li><a href="global.html#Achievements">Achievements</a></li><li><a href="global.html#Analytics">Analytics</a></li><li><a href="global.html#createLog">createLog</a></li><li><a href="global.html#createRepository">createRepository</a></li><li><a href="global.html#createSchema">createSchema</a></li><li><a href="global.html#cursorToMap">cursorToMap</a></li><li><a href="global.html#ensureCollectionExists">ensureCollectionExists</a></li><li><a href="global.html#ensureConnected">ensureConnected</a></li><li><a href="global.html#ensureContextExists">ensureContextExists</a></li><li><a href="global.html#ensureDocument">ensureDocument</a></li><li><a href="global.html#environmentExtensionMixin">environmentExtensionMixin</a></li><li><a href="global.html#expectAsyncError">expectAsyncError</a></li><li><a href="global.html#Feedback">Feedback</a></li><li><a href="global.html#Integer">Integer</a></li><li><a href="global.html#InteractionGraph">InteractionGraph</a></li><li><a href="global.html#oneOf">oneOf</a></li><li><a href="global.html#randomIntInclusive">randomIntInclusive</a></li><li><a href="global.html#RegEx">RegEx</a></li><li><a href="global.html#removeUser">removeUser</a></li><li><a href="global.html#runRemap">runRemap</a></li><li><a href="global.html#updateUserProfile">updateUserProfile</a></li></ul></div><div class="category"><h2>api</h2><h3>Modules</h3><ul><li><a href="module-asyncTimeout.html">asyncTimeout</a></li><li><a href="module-getCollection.html">getCollection</a></li><li><a href="module-getLocalCollection.html">getLocalCollection</a></li><li><a href="module-hasProp.html">hasProp</a></li><li><a href="module-isSchemaInstance.html">isSchemaInstance</a></li></ul><h3>Namespaces</h3><ul><li><a href="ContentConnection.html">ContentConnection</a></li><li><a href="LocalCollections.html">LocalCollections</a></li><li><a href="RestoreCodes.html">RestoreCodes</a></li><li><a href="SensitiveData.html">SensitiveData</a></li></ul><h3><a href="global.html">Global</a></h3></div><div class="category"><h2>contexts</h2><h3>Modules</h3><ul><li><a href="module-countUnitCompetencies.html">countUnitCompetencies</a></li></ul><h3>Namespaces</h3><ul><li><a href="Content.html">Content</a></li><li><a href="ContextRegistry.html">ContextRegistry</a></li><li><a href="MapData.html">MapData</a></li><li><a href="Progress.html">Progress</a></li><li><a href="Response.html">Response</a></li><li><a href="Session.html">Session</a></li><li><a href="SyncState.html">SyncState</a></li><li><a href="Users.html">Users</a></li><li><a href="Users.methods.html">methods</a></li><li><a href="Users.schema.html">schema</a></li></ul></div><div class="category"><h2>startup</h2><h3>Modules</h3><ul><li><a href="module-useFixtures.html">useFixtures</a></li></ul></div>
                
            </nav>
        </div>
        <div class="core" id="main-content-wrapper">
            <div class="content">
                <header class="page-title">
                    <p>Namespace</p>
                    <h1>schema</h1>
                </header>
                

<section>

<header>
    
        <h2>
            <span class="ancestors"><a href="Users.html">Users</a>.</span>schema</h2>
        
    
</header>

<article>
    <div class="container-overview">
    
        
            <div class="description"><p>The db schema definitions.</p></div>
        

<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line34">line 34</a>
            </span>
        </p>
    
</dl>


    </div>
    
    
        <div class='vertical-section'>
            <h1>Members</h1>
            <div class="members">
            
                <div class="member">

<h4 class="name" id=".createdAt">
    <a class="href-link" href="#.createdAt">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        createdAt
    </span>
    
</h4>


<div class="description">
    <p>Determines when this user has been created</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line47">line 47</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".device">
    <a class="href-link" href="#.device">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        device
    </span>
    
</h4>


<div class="description">
    <p>We save the current device info to associate
any client error with it by user-id.
Device info should contain no personal data</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line131">line 131</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".lastLogin">
    <a class="href-link" href="#.lastLogin">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        lastLogin
    </span>
    
</h4>


<div class="description">
    <p>Set when user successfully logs in</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line52">line 52</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".research">
    <a class="href-link" href="#.research">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        research
    </span>
    
</h4>


<div class="description">
    <p>True if 2xoptin for research
has been completed</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line113">line 113</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".restore">
    <a class="href-link" href="#.restore">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        restore
    </span>
    
</h4>


<div class="description">
    <p>The restore code</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line91">line 91</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".services">
    <a class="href-link" href="#.services">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        services
    </span>
    
</h4>


<div class="description">
    <p>services schema can be a bit complex at times, since Meteor uses it
for multiple authentication and verification scenarios</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line61">line 61</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".speed">
    <a class="href-link" href="#.speed">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        speed
    </span>
    
</h4>


<div class="description">
    <p>The selected tts voice speed</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line104">line 104</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".username">
    <a class="href-link" href="#.username">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        username
    </span>
    
</h4>


<div class="description">
    <p>Definition for valid usernames.</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line38">line 38</a>
            </span>
        </p>
    
</dl>


</div>
            
                <div class="member">

<h4 class="name" id=".voice">
    <a class="href-link" href="#.voice">#</a>
    
        
            <span class='tag'>static</span>
        
    
    <span class="code-name">
        voice
    </span>
    
</h4>


<div class="description">
    <p>The selected tts voice</p>
</div>


<dl class="details">

    
        <p class="tag-source">
            <a href="contexts_users_Users.js.html" class="button">View Source</a>
            <span>
                <a href="contexts_users_Users.js.html">contexts/users/Users.js</a>, <a href="contexts_users_Users.js.html#line96">line 96</a>
            </span>
        </p>
    
</dl>


</div>
            
            </div>
        </div>
    

</article>

</section>


            </div>
            
            <footer class="footer">
                <div class="content has-text-centered">
                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.11</a></p>
                    <p class="sidebar-created-by">
                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
                    </p>
                </div>
            </footer>
            
        </div>
        <div id="side-nav" class="side-nav">
        </div>
    </div>
<script src="scripts/app.min.js"></script>
<script>PR.prettyPrint();</script>
<script src="scripts/linenumber.js"> </script>

<script src="scripts/search.js"> </script>


</body>
</html>