webgme-engine

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: AddOnBase</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <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">Class: AddOnBase</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>AddOnBase<span class="signature">(logger, gmeConfig)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="AddOnBase"><span class="type-signature"></span>new AddOnBase<span class="signature">(logger, gmeConfig)</span><span class="type-signature"></span></h4> <div class="description"> <p>BaseClass for AddOns which run on the server and act upon changes in a branch. Use the AddOnGenerator to generate a new AddOn that implements this class.</p> </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>logger</code></td> <td class="type"> <span class="param-type"><a href="GmeLogger.html">GmeLogger</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>gmeConfig</code></td> <td class="type"> <span class="param-type"><a href="global.html#GmeConfig">GmeConfig</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line24">line 24</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id="blobClient"><span class="type-signature"></span>blobClient<span class="type-signature"> :<a href="BlobClient.html">BlobClient</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="BlobClient.html">BlobClient</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line54">line 54</a> </li></ul></dd> </dl> <h4 class="name" id="branchName"><span class="type-signature"></span>branchName<span class="type-signature"> :<a href="global.html#string">string</a></span></h4> <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="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line49">line 49</a> </li></ul></dd> </dl> <h4 class="name" id="core"><span class="type-signature"></span>core<span class="type-signature"> :<a href="Core.html">Core</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Core.html">Core</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line39">line 39</a> </li></ul></dd> </dl> <h4 class="name" id="gmeConfig"><span class="type-signature"></span>gmeConfig<span class="type-signature"> :<a href="global.html#GmeConfig">GmeConfig</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="global.html#GmeConfig">GmeConfig</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line28">line 28</a> </li></ul></dd> </dl> <h4 class="name" id="logger"><span class="type-signature"></span>logger<span class="type-signature"> :<a href="GmeLogger.html">GmeLogger</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="GmeLogger.html">GmeLogger</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line33">line 33</a> </li></ul></dd> </dl> <h4 class="name" id="project"><span class="type-signature"></span>project<span class="type-signature"> :<a href="Project.html">Project</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="Project.html">Project</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line44">line 44</a> </li></ul></dd> </dl> <h4 class="name" id="updateResult"><span class="type-signature"></span>updateResult<span class="type-signature"> :<a href="AddOnUpdateResult.html">AddOnUpdateResult</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="AddOnUpdateResult.html">AddOnUpdateResult</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line61">line 61</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="addCommitMessage"><span class="type-signature"></span>addCommitMessage<span class="signature">(msg)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creats or appends commit message for the current update-cycle.</p> </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>msg</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line173">line 173</a> </li></ul></dd> </dl> <h4 class="name" id="addNotification"><span class="type-signature"></span>addNotification<span class="signature">(message)</span><span class="type-signature"></span></h4> <div class="description"> <p>Adds a notification to all sockets connected to the branch room. The notification will be sent after the update-callback has been invoked.</p> </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>message</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"><p>Message string or object containing message.</p> <h6>Properties</h6> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th>Default</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="attributes"> </td> <td class="default"> </td> <td class="description last"><p>If object it must contain a message.</p></td> </tr> <tr> <td class="name"><code>severity</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 'info' </td> <td class="description last"><p>Severity level ('success', 'info', 'warn', 'error')</p></td> </tr> </tbody> </table> </td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line184">line 184</a> </li></ul></dd> </dl> <h4 class="name" id="configure"><span class="type-signature"></span>configure<span class="signature">(configuration, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Configures the AddOn</p> </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>configuration</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#function">function</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line74">line 74</a> </li></ul></dd> </dl> <h4 class="name" id="getDefaultQueryParams"><span class="type-signature"></span>getDefaultQueryParams<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#object">object</a>}</span></h4> <div class="description"> <p>Returns the default values of the Query Parameters.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line249">line 249</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#object">object</a></span> </dd> </dl> <h4 class="name" id="getDescription"><span class="type-signature"></span>getDescription<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>A detailed description of this AddOn and its purpose. It can be one or more sentences.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line103">line 103</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getName"><span class="type-signature"></span>getName<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Readable name of this AddOn that can contain spaces.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line86">line 86</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getQueryParamsStructure"><span class="type-signature"></span>getQueryParamsStructure<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#Array">Array</a>.<<a href="global.html#object">object</a>>}</span></h4> <div class="description"> <p>Structure of query parameters with names, descriptions, minimum, maximum values, default values and type definitions.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line205">line 205</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#Array">Array</a>.<<a href="global.html#object">object</a>></span> </dd> </dl> <h4 class="name" id="getVersion"><span class="type-signature"></span>getVersion<span class="signature">()</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Current version of this AddOn using semantic versioning.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line95">line 95</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="initialize"><span class="type-signature"></span>initialize<span class="signature">(rootNode, commitObj, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Called once when the AddOn is started for the first time.</p> </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>rootNode</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>commitObj</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#function">function</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line127">line 127</a> </li></ul></dd> </dl> <h4 class="name" id="query"><span class="type-signature"></span>query<span class="signature">(commitHash, queryParams, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>Queries are typically invoked by users from a client. The AddOn is not suppose to make any changes to either the model's or the AddOn's state. (Since users can share a running instance of an AddOn).</p> </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>commitHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>State of the invoker.</p></td> </tr> <tr> <td class="name"><code>queryParams</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"><p>Values based on the 'getQueryParametersStructure'.</p></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#function">function</a></span> </td> <td class="description last"><p>resolves with PluginResult.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line216">line 216</a> </li></ul></dd> </dl> <h4 class="name" id="setToken"><span class="type-signature"></span>setToken<span class="signature">(token)</span><span class="type-signature"></span></h4> <div class="description"> <p>Overwrite this if you are sending requests to the webgme server. Make sure to still update the blob-clients token.</p> </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>token</code></td> <td class="type"> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line238">line 238</a> </li></ul></dd> </dl> <h4 class="name" id="update"><span class="type-signature"></span>update<span class="signature">(rootNode, commitObj, callback)</span><span class="type-signature"></span></h4> <div class="description"> <p>This is invoked after each commit to the branch. AddOns are allowed to make changes on updates, but should not persist by themselves. The manager/monitor will persist after each AddOn has had its way (ordered by the "usedAddOn" registry in the rootNode).</p> <p>Changes made by AddOns do not trigger a new update for other addOns.</p> </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>rootNode</code></td> <td class="type"> <span class="param-type"><a href="module-Core.html#~Node">module:Core~Node</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>commitObj</code></td> <td class="type"> <span class="param-type"><a href="module-Storage.html#~CommitObject">module:Storage~CommitObject</a></span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>callback</code></td> <td class="type"> <span class="param-type"><a href="global.html#function">function</a></span> </td> <td class="description last"></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="addon_AddOnBase.js.html">addon/AddOnBase.js</a>, <a href="addon_AddOnBase.js.html#line117">line 117</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>