Skip to content
Permalink
71b429b8cf
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Website/docs/jsdoc/global.html

Go to file
 
 
Cannot retrieve contributors at this time
811 lines (150 sloc) 8.71 KB
Raw Blame
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Global</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">Global</h1>
<section>
<header>
<h2></h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="FileDownloadPage"><span class="type-signature"></span>File Download Page<span class="type-signature"></span></h4>
<div class="description">
A secure page where a user downloads their chosen file.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line199">line 199</a>
</li></ul></dd>
</dl>
<h4 class="name" id="FileListPage"><span class="type-signature"></span>File List Page<span class="type-signature"></span></h4>
<div class="description">
A secure page where a user can view information about the files available to them and download them.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line178">line 178</a>
</li></ul></dd>
</dl>
<h4 class="name" id="FileSharingPage"><span class="type-signature"></span>File Sharing Page<span class="type-signature"></span></h4>
<div class="description">
A secure page where a user can get the information they need to share their file.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line160">line 160</a>
</li></ul></dd>
</dl>
<h4 class="name" id="HomePage"><span class="type-signature"></span>Home Page<span class="type-signature"></span></h4>
<div class="description">
The secure home page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line38">line 38</a>
</li></ul></dd>
</dl>
<h4 class="name" id="LogOutPage"><span class="type-signature"></span>Log Out Page<span class="type-signature"></span></h4>
<div class="description">
User is logged out and redirected to the home page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line229">line 229</a>
</li></ul></dd>
</dl>
<h4 class="name" id="LoginPage"><span class="type-signature"></span>Login Page<span class="type-signature"></span></h4>
<div class="description">
The login page that all users can see.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line86">line 86</a>
</li></ul></dd>
</dl>
<h4 class="name" id="LoginScript"><span class="type-signature"></span>Login Script<span class="type-signature"></span></h4>
<div class="description">
The script to handle users logging in.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line101">line 101</a>
</li></ul></dd>
</dl>
<h4 class="name" id="RegisterPage"><span class="type-signature"></span>Register Page<span class="type-signature"></span></h4>
<div class="description">
The user registration page.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line59">line 59</a>
</li></ul></dd>
</dl>
<h4 class="name" id="RegisterScript"><span class="type-signature"></span>Register Script<span class="type-signature"></span></h4>
<div class="description">
The script to process new user registrations.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line67">line 67</a>
</li></ul></dd>
</dl>
<h4 class="name" id="UploadPage"><span class="type-signature"></span>Upload Page<span class="type-signature"></span></h4>
<div class="description">
A secure page where a user can upload a file.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line120">line 120</a>
</li></ul></dd>
</dl>
<h4 class="name" id="UploadScript"><span class="type-signature"></span>Upload Script<span class="type-signature"></span></h4>
<div class="description">
The script that handles uploading a user's file to the server.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line139">line 139</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-download.html">download</a></li><li><a href="module-remove.html">remove</a></li><li><a href="module-upload.html">upload</a></li><li><a href="module-user.html">user</a></li></ul><h3>Classes</h3><ul><li><a href="module-download.download.html">download</a></li><li><a href="module-remove.remove.html">remove</a></li><li><a href="module-upload.upload.html">upload</a></li><li><a href="module-user.user.html">user</a></li></ul><h3>Global</h3><ul><li><a href="global.html#FileDownloadPage">File Download Page</a></li><li><a href="global.html#FileListPage">File List Page</a></li><li><a href="global.html#FileSharingPage">File Sharing Page</a></li><li><a href="global.html#HomePage">Home Page</a></li><li><a href="global.html#LogOutPage">Log Out Page</a></li><li><a href="global.html#LoginPage">Login Page</a></li><li><a href="global.html#LoginScript">Login Script</a></li><li><a href="global.html#RegisterPage">Register Page</a></li><li><a href="global.html#RegisterScript">Register Script</a></li><li><a href="global.html#UploadPage">Upload Page</a></li><li><a href="global.html#UploadScript">Upload Script</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 3.6.3</a> on Mon Nov 25 2019 17:25:00 GMT+0000 (Greenwich Mean Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>