189 lines
No EOL
11 KiB
HTML
189 lines
No EOL
11 KiB
HTML
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
|
|
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
|
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
|
<head>
|
|
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
|
|
|
|
<title>3. Server Side API — Documentation</title>
|
|
<link rel="stylesheet" href="_static/sphinxdoc.css" type="text/css" />
|
|
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
|
|
<script type="text/javascript">
|
|
var DOCUMENTATION_OPTIONS = {
|
|
URL_ROOT: '',
|
|
VERSION: '',
|
|
COLLAPSE_MODINDEX: false,
|
|
FILE_SUFFIX: '.html',
|
|
HAS_SOURCE: true
|
|
};
|
|
</script>
|
|
<script type="text/javascript" src="_static/jquery.js"></script>
|
|
<script type="text/javascript" src="_static/doctools.js"></script>
|
|
<link rel="top" title="Documentation" href="index.html" />
|
|
<link rel="next" title="Database API Functions" href="database_api.html" />
|
|
<link rel="prev" title="Creating Reports" href="creating_reports.html" />
|
|
</head>
|
|
<body>
|
|
<div style="background-color: #FFF; text-align: left; padding: 8px 0px"><img src="_static/banner300910.gif"></div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
accesskey="I">index</a></li>
|
|
<li class="right" >
|
|
<a href="modindex.html" title="Global Module Index"
|
|
accesskey="M">modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="database_api.html" title="Database API Functions"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="creating_reports.html" title="Creating Reports"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="index.html">Documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="creating_reports.html"
|
|
title="previous chapter">Creating Reports</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="database_api.html"
|
|
title="next chapter">Database API Functions</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="_sources/server_side_api.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="search.html" method="get">
|
|
<input type="text" name="q" size="18" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="server-side-api">
|
|
<h1>3. Server Side API<a class="headerlink" href="#server-side-api" title="Permalink to this headline">¶</a></h1>
|
|
<p>List of modules on the server-side that are commonly used for developing applications</p>
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference external" href="database_api.html">Database API Functions</a></li>
|
|
<li class="toctree-l1"><a class="reference external" href="doc.html"><tt class="docutils literal"><span class="pre">doc</span></tt> — Document (ORM)</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="doc.html#document-object">Document object</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="doc.html#standard-methods-for-api">Standard methods for API</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="doc.html#naming">Naming</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="doc.html#inheritance">Inheritance</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="doc.html#example">Example</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="utils_server.html"><tt class="docutils literal"><span class="pre">utils</span></tt> — Utilities Module</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#date-and-time-functions">Date and Time Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#datatype-conversions">Datatype Conversions</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#defaults">Defaults</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#file-blob-functions">File (BLOB) Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#email-functions">Email Functions</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="utils_server.html#other-functions">Other Functions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="email_lib.html"><tt class="docutils literal"><span class="pre">email_lib</span></tt> — Email</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="email_lib.html#email-object">Email object</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="email_lib.html#example">Example</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="profile.html"><tt class="docutils literal"><span class="pre">profile</span></tt> — Profile</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="profile.html#profile-object">Profile object</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="webservice.html"><tt class="docutils literal"><span class="pre">webservice</span></tt> — Remote Framework Access via HTTP</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="webservice.html#framework-server-class">Framework Server Class</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="webservice.html#example">Example</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l1"><a class="reference external" href="server_side_internals.html">Server Side Internals</a><ul>
|
|
<li class="toctree-l2"><a class="reference external" href="auth.html"><tt class="docutils literal"><span class="pre">auth</span></tt> — Authentication</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="auth.html#authentication-object">Authentication object</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="webnotes.html"><tt class="docutils literal"><span class="pre">webnotes</span></tt> — Webnotes Module</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="webnotes.html#global-attributes">Global Attributes</a></li>
|
|
<li class="toctree-l3"><a class="reference external" href="webnotes.html#global-functions">Global Functions</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="doclist.html"><tt class="docutils literal"><span class="pre">doclist</span></tt> — Doclist Module</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="doclist.html#functions-for-internal-use">functions for internal use</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="doctype.html"><tt class="docutils literal"><span class="pre">doctype</span></tt> — DocType</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="doctype.html#doctype-object">_DocType object</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="code.html"><tt class="docutils literal"><span class="pre">code</span></tt> — Code Execution Module</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="code.html#global-properties-methods-generally-used-in-server-side-scripts">Global Properties / Methods (generally) used in server side scripts</a></li>
|
|
<li class="toctree-l3"><a class="reference external" href="code.html#module-methods">Module Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="db_schema.html"><tt class="docutils literal"><span class="pre">db_schema</span></tt> — Database Schema Management Module</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="db_schema.html#standard-fields-of-a-record">Standard fields of a record</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="db.html"><tt class="docutils literal"><span class="pre">db</span></tt> — Database</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="db.html#database-object-conn">database object — conn</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="page_body.html"><tt class="docutils literal"><span class="pre">page_body</span></tt> — Page Body Serverside Module</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="form_server.html"><tt class="docutils literal"><span class="pre">form</span></tt> — Form Module</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="page_server.html"><tt class="docutils literal"><span class="pre">page</span></tt> — Page Module</a><ul>
|
|
<li class="toctree-l3"><a class="reference external" href="page_server.html#internal-methods">Internal Methods</a></li>
|
|
</ul>
|
|
</li>
|
|
<li class="toctree-l2"><a class="reference external" href="menus_server.html"><tt class="docutils literal"><span class="pre">menus_server</span></tt> — Menus Serverside Module</a></li>
|
|
<li class="toctree-l2"><a class="reference external" href="module.html"><tt class="docutils literal"><span class="pre">module</span></tt> — Module Module</a></li>
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<h3>Navigation</h3>
|
|
<ul>
|
|
<li class="right" style="margin-right: 10px">
|
|
<a href="genindex.html" title="General Index"
|
|
>index</a></li>
|
|
<li class="right" >
|
|
<a href="modindex.html" title="Global Module Index"
|
|
>modules</a> |</li>
|
|
<li class="right" >
|
|
<a href="database_api.html" title="Database API Functions"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="creating_reports.html" title="Creating Reports"
|
|
>previous</a> |</li>
|
|
<li><a href="index.html">Documentation</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2010, Rushabh Mehta.
|
|
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 0.6.3.
|
|
</div>
|
|
</body>
|
|
</html> |