MaketRandevu/doc/code/js/BackendUsers.html
2015-01-28 23:54:11 +01:00

505 lines
No EOL
6.9 KiB
HTML

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: BackendUsers</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: BackendUsers</h1>
<section>
<header>
<h2>
BackendUsers
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">This namespace handles the js functionality of the users backend page. It uses three other
classes (defined below) in order to handle the admin, provider and secretary record types.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_users.js.html">backend_users.js</a>, <a href="backend_users.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id=".helper"><span class="type-signature">(static) </span>helper<span class="type-signature"> :<a href="AdminsHelper.html">AdminsHelper</a>|<a href="ProvidersHelper.html">ProvidersHelper</a>|<a href="SecretariesHelper.html">SecretariesHelper</a></span></h4>
<div class="description">
Contains the current tab record methods for the page.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="AdminsHelper.html">AdminsHelper</a></span>
|
<span class="param-type"><a href="ProvidersHelper.html">ProvidersHelper</a></span>
|
<span class="param-type"><a href="SecretariesHelper.html">SecretariesHelper</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_users.js.html">backend_users.js</a>, <a href="backend_users.js.html#line15">line 15</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".wp"><span class="type-signature">(static) </span>wp<span class="type-signature"> :object</span></h4>
<div class="description">
Use this class instance for performing actions on the working plan.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_users.js.html">backend_users.js</a>, <a href="backend_users.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id=".bindEventHandlers"><span class="type-signature">(static) </span>bindEventHandlers<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
Binds the defauly backend users event handlers. Do not use this method on a different
page because it needs the backend users page DOM.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_users.js.html">backend_users.js</a>, <a href="backend_users.js.html#line79">line 79</a>
</li></ul></dd>
</dl>
<h4 class="name" id=".initialize"><span class="type-signature">(static) </span>initialize<span class="signature">(defaultEventHandlers)</span><span class="type-signature"></span></h4>
<div class="description">
Initialize the backend users page.
</div>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>defaultEventHandlers</code></td>
<td class="type">
<span class="param-type">bool</span>
</td>
<td class="description last">(OPTIONAL) Whether to bind the default event handlers
(default: true).</td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="backend_users.js.html">backend_users.js</a>, <a href="backend_users.js.html#line30">line 30</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="AdminsHelper.html">AdminsHelper</a></li><li><a href="CategoriesHelper.html">CategoriesHelper</a></li><li><a href="CustomersHelper.html">CustomersHelper</a></li><li><a href="ProvidersHelper.html">ProvidersHelper</a></li><li><a href="SecretariesHelper.html">SecretariesHelper</a></li><li><a href="ServicesHelper.html">ServicesHelper</a></li><li><a href="SystemSettings.html">SystemSettings</a></li><li><a href="UserSettings.html">UserSettings</a></li><li><a href="WorkingPlan.html">WorkingPlan</a></li></ul><h3>Namespaces</h3><ul><li><a href="Backend.html">Backend</a></li><li><a href="BackendCalendar.html">BackendCalendar</a></li><li><a href="BackendCustomers.html">BackendCustomers</a></li><li><a href="BackendServices.html">BackendServices</a></li><li><a href="BackendSettings.html">BackendSettings</a></li><li><a href="BackendUsers.html">BackendUsers</a></li><li><a href="FrontendBook.html">FrontendBook</a></li><li><a href="GeneralFunctions.html">GeneralFunctions</a></li></ul><h3>Global</h3><ul><li><a href="global.html#enableCancel">enableCancel</a></li><li><a href="global.html#enableSubmit">enableSubmit</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha13</a> on Wed Jan 28 2015 23:12:50 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>