webgme-engine
Version:
WebGME server and Client API without a GUI
1,443 lines (378 loc) • 21.3 kB
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">Type Definitions</h3>
<h4 class="name" id="Array">Array</h4>
<div class="description">
<p>Javascript Array class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#Array">Array</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line52">line 52</a>
</li></ul></dd>
</dl>
<h4 class="name" id="Error">Error</h4>
<div class="description">
<p>JavaScript Error class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Error">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#object">object</a></span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>message</code></td>
<td class="type">
<span class="param-type"><a href="global.html#string">string</a></span>
</td>
<td class="description last"><p>Message typically set in the constructor.</p></td>
</tr>
<tr>
<td class="name"><code>stack</code></td>
<td class="type">
<span class="param-type">stack</span>
</td>
<td class="description last"><p>Detailed stack trace.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line14">line 14</a>
</li></ul></dd>
</dl>
<h4 class="name" id="GmeConfig">GmeConfig</h4>
<div class="description">
<p>The main configuration object of the WebGME. For detailed information about the individual
options, look up the <a href="https://github.com/webgme/webgme/tree/master/config/README.md">wiki</a> pages.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#object">object</a></span>
</li>
</ul>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>addOn</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Add-on related settings.</p></td>
</tr>
<tr>
<td class="name"><code>authentication</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Authentication related settings.</p></td>
</tr>
<tr>
<td class="name"><code>bin</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Bin script related settings.</p></td>
</tr>
<tr>
<td class="name"><code>blob</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Blob related settings.</p></td>
</tr>
<tr>
<td class="name"><code>client</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Client related settings.</p></td>
</tr>
<tr>
<td class="name"><code>core</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Client related settings.</p></td>
</tr>
<tr>
<td class="name"><code>debug</code></td>
<td class="type">
<span class="param-type"><a href="global.html#boolean">boolean</a></span>
</td>
<td class="description last"><p>Enables debug mode.</p></td>
</tr>
<tr>
<td class="name"><code>executor</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Executor related settings.</p></td>
</tr>
<tr>
<td class="name"><code>mongo</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Mongo database related settings.</p></td>
</tr>
<tr>
<td class="name"><code>plugin</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Plugin related settings.</p></td>
</tr>
<tr>
<td class="name"><code>requirejsPaths</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Additional paths to for requirejs.</p></td>
</tr>
<tr>
<td class="name"><code>rest</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>REST related settings.</p></td>
</tr>
<tr>
<td class="name"><code>seedProjects</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Seed related settings.</p></td>
</tr>
<tr>
<td class="name"><code>server</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Server related settings.</p></td>
</tr>
<tr>
<td class="name"><code>socketIO</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Socket IO related settings.</p></td>
</tr>
<tr>
<td class="name"><code>storage</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Storage related settings.</p></td>
</tr>
<tr>
<td class="name"><code>visualization</code></td>
<td class="type">
<span class="param-type"><a href="global.html#object">object</a></span>
</td>
<td class="description last"><p>Visualization related settings.</p></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line76">line 76</a>
</li></ul></dd>
</dl>
<h4 class="name" id="boolean">boolean</h4>
<div class="description">
<p>Javascript Boolean class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Boolean">reference</a></p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#boolean">boolean</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line46">line 46</a>
</li></ul></dd>
</dl>
<h4 class="name" id="function"><span class="type-signature"></span>function<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Javascript function class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Function">reference</a>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line58">line 58</a>
</li></ul></dd>
</dl>
<h4 class="name" id="integer">integer</h4>
<div class="description">
<p>Represents an integer from the Number class of Javascript. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#integer">integer</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
<h4 class="name" id="null">null</h4>
<div class="description">
<p>Javascript null literal. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/null">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#null">null</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line34">line 34</a>
</li></ul></dd>
</dl>
<h4 class="name" id="number">number</h4>
<div class="description">
<p>Javascript Number class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Number">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#number">number</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line64">line 64</a>
</li></ul></dd>
</dl>
<h4 class="name" id="object">object</h4>
<div class="description">
<p>Javascript Object class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#object">object</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line22">line 22</a>
</li></ul></dd>
</dl>
<h4 class="name" id="string">string</h4>
<div class="description">
<p>Javascript String class. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#string">string</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line28">line 28</a>
</li></ul></dd>
</dl>
<h4 class="name" id="undefined">undefined</h4>
<div class="description">
<p>Javascript undefined literal. For more information, look up the
<a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/undefined">reference</a>.</p>
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type"><a href="global.html#undefined">undefined</a></span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="docs_def.doc.js.html">docs/def.doc.js</a>, <a href="docs_def.doc.js.html#line40">line 40</a>
</li></ul></dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="Server_GMEAuth.html">Server:GMEAuth</a></li><li><a href="Server_SafeStorage.html">Server:SafeStorage</a></li><li><a href="Server_UserProject.html">Server:UserProject</a></li><li><a href="module-Core.html">Core</a></li><li><a href="module-Storage.html">Storage</a></li><li><a href="module-crosscuts.html">crosscuts</a></li><li><a href="module-serialization.html">serialization</a></li></ul><h3>Externals</h3><ul><li><a href="external-Promise.html">Promise</a></li></ul><h3>Classes</h3><ul><li><a href="AddOnBase.html">AddOnBase</a></li><li><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></li><li><a href="Artifact.html">Artifact</a></li><li><a href="BlobClient.html">BlobClient</a></li><li><a href="BlobMetadata.html">BlobMetadata</a></li><li><a href="BlobRunPluginClient.html">BlobRunPluginClient</a></li><li><a href="Client.html">Client</a></li><li><a href="Core.html">Core</a></li><li><a href="ExecutorClient.html">ExecutorClient</a></li><li><a href="GMENode.html">GMENode</a></li><li><a href="GmeLogger.html">GmeLogger</a></li><li><a href="InterPluginResult.html">InterPluginResult</a></li><li><a href="JobInfo.html">JobInfo</a></li><li><a href="OutputInfo.html">OutputInfo</a></li><li><a href="PluginBase.html">PluginBase</a></li><li><a href="PluginConfig.html">PluginConfig</a></li><li><a href="PluginMessage.html">PluginMessage</a></li><li><a href="PluginNodeDescription.html">PluginNodeDescription</a></li><li><a href="PluginResult.html">PluginResult</a></li><li><a href="Project.html">Project</a></li><li><a href="ProjectInterface.html">ProjectInterface</a></li><li><a href="Server_GMEAuth-GMEAuth.html">GMEAuth</a></li><li><a href="Server_SafeStorage-SafeStorage.html">SafeStorage</a></li><li><a href="Server_UserProject-UserProject.html">UserProject</a></li><li><a href="WebsocketRouter.html">WebsocketRouter</a></li><li><a href="WebsocketRouterUser.html">WebsocketRouterUser</a></li></ul><h3>Events</h3><ul><li><a href="Client.html#event:BRANCH_CHANGED">BRANCH_CHANGED</a></li><li><a href="Client.html#event:BRANCH_CLOSED">BRANCH_CLOSED</a></li><li><a href="Client.html#event:BRANCH_OPENED">BRANCH_OPENED</a></li><li><a href="Client.html#event:BRANCH_STATUS_CHANGED">BRANCH_STATUS_CHANGED</a></li><li><a href="Client.html#event:CONNECTED_USERS_CHANGED">CONNECTED_USERS_CHANGED</a></li><li><a href="Client.html#event:NETWORK_STATUS_CHANGED">NETWORK_STATUS_CHANGED</a></li><li><a href="Client.html#event:NOTIFICATION">NOTIFICATION</a></li><li><a href="Client.html#event:PLUGIN_FINISHED">PLUGIN_FINISHED</a></li><li><a href="Client.html#event:PLUGIN_INITIATED">PLUGIN_INITIATED</a></li><li><a href="Client.html#event:PLUGIN_NOTIFICATION">PLUGIN_NOTIFICATION</a></li><li><a href="Client.html#event:PROJECT_CLOSED">PROJECT_CLOSED</a></li><li><a href="Client.html#event:PROJECT_OPENED">PROJECT_OPENED</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.2</a> on Fri Jun 21 2024 09:43:40 GMT-0400 (Eastern Daylight Time)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>