diff options
Diffstat (limited to 'docs/_build/html/autoapi/app/models')
| -rw-r--r-- | docs/_build/html/autoapi/app/models/index.html | 216 |
1 files changed, 216 insertions, 0 deletions
diff --git a/docs/_build/html/autoapi/app/models/index.html b/docs/_build/html/autoapi/app/models/index.html new file mode 100644 index 0000000..28c12c6 --- /dev/null +++ b/docs/_build/html/autoapi/app/models/index.html @@ -0,0 +1,216 @@ + +<!DOCTYPE html> + +<html> + <head> + <meta charset="utf-8" /> + <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="generator" content="Docutils 0.17.1: http://docutils.sourceforge.net/" /> + + <title>app.models — SaaS in a Flask 0.1.0 documentation</title> + <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/alabaster.css" /> + <link rel="stylesheet" type="text/css" href="../../../_static/graphviz.css" /> + <script data-url_root="../../../" id="documentation_options" src="../../../_static/documentation_options.js"></script> + <script src="../../../_static/jquery.js"></script> + <script src="../../../_static/underscore.js"></script> + <script src="../../../_static/doctools.js"></script> + <link rel="index" title="Index" href="../../../genindex.html" /> + <link rel="search" title="Search" href="../../../search.html" /> + + <link rel="stylesheet" href="../../../_static/custom.css" type="text/css" /> + + + <meta name="viewport" content="width=device-width, initial-scale=0.9, maximum-scale=0.9" /> + + </head><body> + + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + + + <div class="body" role="main"> + + <section id="module-app.models"> +<span id="app-models"></span><h1><a class="reference internal" href="#module-app.models" title="app.models"><code class="xref py py-mod docutils literal notranslate"><span class="pre">app.models</span></code></a><a class="headerlink" href="#module-app.models" title="Permalink to this headline">¶</a></h1> +<section id="module-contents"> +<h2>Module Contents<a class="headerlink" href="#module-contents" title="Permalink to this headline">¶</a></h2> +<section id="classes"> +<h3>Classes<a class="headerlink" href="#classes" title="Permalink to this headline">¶</a></h3> +<table class="longtable docutils align-default"> +<colgroup> +<col style="width: 10%" /> +<col style="width: 90%" /> +</colgroup> +<tbody> +<tr class="row-odd"><td><p><a class="reference internal" href="#app.models.User" title="app.models.User"><code class="xref py py-obj docutils literal notranslate"><span class="pre">User</span></code></a></p></td> +<td><p>This provides default implementations for the methods that Flask-Login</p></td> +</tr> +</tbody> +</table> +<dl class="py class"> +<dt class="sig sig-object py" id="app.models.User"> +<em class="property"><span class="pre">class</span> </em><span class="sig-prename descclassname"><span class="pre">app.models.</span></span><span class="sig-name descname"><span class="pre">User</span></span><a class="headerlink" href="#app.models.User" title="Permalink to this definition">¶</a></dt> +<dd><p>Bases: <code class="xref py py-obj docutils literal notranslate"><span class="pre">app.db.Model</span></code>, <code class="xref py py-obj docutils literal notranslate"><span class="pre">flask_login.UserMixin</span></code></p> +<p>This provides default implementations for the methods that Flask-Login +expects user objects to have.</p> +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.__tablename__"> +<span class="sig-name descname"><span class="pre">__tablename__</span></span><em class="property"> <span class="pre">=</span> <span class="pre">users</span></em><a class="headerlink" href="#app.models.User.__tablename__" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.first_name"> +<span class="sig-name descname"><span class="pre">first_name</span></span><a class="headerlink" href="#app.models.User.first_name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.last_name"> +<span class="sig-name descname"><span class="pre">last_name</span></span><a class="headerlink" href="#app.models.User.last_name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.email"> +<span class="sig-name descname"><span class="pre">email</span></span><a class="headerlink" href="#app.models.User.email" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.confirmation"> +<span class="sig-name descname"><span class="pre">confirmation</span></span><a class="headerlink" href="#app.models.User.confirmation" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.paid"> +<span class="sig-name descname"><span class="pre">paid</span></span><a class="headerlink" href="#app.models.User.paid" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.role"> +<span class="sig-name descname"><span class="pre">role</span></span><a class="headerlink" href="#app.models.User.role" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.team"> +<span class="sig-name descname"><span class="pre">team</span></span><a class="headerlink" href="#app.models.User.team" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User.login_type"> +<span class="sig-name descname"><span class="pre">login_type</span></span><a class="headerlink" href="#app.models.User.login_type" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py attribute"> +<dt class="sig sig-object py" id="app.models.User._password"> +<span class="sig-name descname"><span class="pre">_password</span></span><a class="headerlink" href="#app.models.User._password" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.full_name"> +<em class="property"><span class="pre">property</span> </em><span class="sig-name descname"><span class="pre">full_name</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.full_name" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.password"> +<span class="sig-name descname"><span class="pre">password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.password" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.check_password"> +<span class="sig-name descname"><span class="pre">check_password</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">plaintext</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.check_password" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.get_id"> +<span class="sig-name descname"><span class="pre">get_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.get_id" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.get_role"> +<span class="sig-name descname"><span class="pre">get_role</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.get_role" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.get_team"> +<span class="sig-name descname"><span class="pre">get_team</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.get_team" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +<dl class="py method"> +<dt class="sig sig-object py" id="app.models.User.is_paid"> +<span class="sig-name descname"><span class="pre">is_paid</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">self</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#app.models.User.is_paid" title="Permalink to this definition">¶</a></dt> +<dd></dd></dl> + +</dd></dl> + +</section> +</section> +</section> + + + </div> + + </div> + </div> + <div class="sphinxsidebar" role="navigation" aria-label="main navigation"> + <div class="sphinxsidebarwrapper"> +<h1 class="logo"><a href="../../../index.html">SaaS in a Flask</a></h1> + + + + + + + + +<h3>Navigation</h3> +<p class="caption"><span class="caption-text">Contents:</span></p> +<ul> +<li class="toctree-l1"><a class="reference internal" href="../../index.html">API Reference</a></li> +</ul> + +<div class="relations"> +<h3>Related Topics</h3> +<ul> + <li><a href="../../../index.html">Documentation overview</a><ul> + </ul></li> +</ul> +</div> +<div id="searchbox" style="display: none" role="search"> + <h3 id="searchlabel">Quick search</h3> + <div class="searchformwrapper"> + <form class="search" action="../../../search.html" method="get"> + <input type="text" name="q" aria-labelledby="searchlabel" /> + <input type="submit" value="Go" /> + </form> + </div> +</div> +<script>$('#searchbox').show(0);</script> + + + + + + + + + </div> + </div> + <div class="clearer"></div> + </div> + <div class="footer"> + ©2021, Navan Chauhan. + + | + Powered by <a href="http://sphinx-doc.org/">Sphinx 4.0.2</a> + & <a href="https://github.com/bitprophet/alabaster">Alabaster 0.7.12</a> + + | + <a href="../../../_sources/autoapi/app/models/index.rst.txt" + rel="nofollow">Page source</a> + </div> + + + + + </body> +</html>
\ No newline at end of file |