webgme-engine

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Class: BlobClient</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: BlobClient</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>BlobClient<span class="signature">(parameters)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="BlobClient"><span class="type-signature"></span>new BlobClient<span class="signature">(parameters)</span><span class="type-signature"></span></h4> <div class="description"> <p>Client to interact with the blob-storage. <br></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>parameters</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a></span> </td> <td class="description last"> <h6>Properties</h6> <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="global.html#object">object</a></span> </td> <td class="description last"></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="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line27">line 27</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="createArtifact"><span class="type-signature"></span>createArtifact<span class="signature">(name)</span><span class="type-signature"> → {<a href="Artifact.html">Artifact</a>}</span></h4> <div class="description"> <p>Creates a new artifact and adds it to array of artifacts of the instance.</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>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="description last"><p>Name of artifact</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line597">line 597</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="Artifact.html">Artifact</a></span> </dd> </dl> <h4 class="name" id="getArtifact"><span class="type-signature"></span>getArtifact<span class="signature">(metadataHash, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Retrieves the <a href="Artifact.html">Artifact</a> from the blob storage.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type">hash</span> </td> <td class="attributes"> </td> <td class="description last"><p>hash associated with the artifact.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line612">line 612</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with <a href="Artifact.html">Artifact</a> <b>artifact</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="getDownloadURL"><span class="type-signature"></span>getDownloadURL<span class="signature">(metadataHash, subpath<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Returns the get-url for downloading a blob.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>subpath</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="description last"><p>optional file-like path to sub-object if complex blob</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line149">line 149</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>get-url for blob</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="global.html#string">string</a></span> </dd> </dl> <h4 class="name" id="getHumanSize"><span class="type-signature"></span>getHumanSize<span class="signature">(bytes, si<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="global.html#string">string</a>}</span></h4> <div class="description"> <p>Converts bytes to a human readable string.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>bytes</code></td> <td class="type"> <span class="param-type"><a href="global.html#number">number</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>File size in bytes.</p></td> </tr> <tr> <td class="name"><code>si</code></td> <td class="type"> <span class="param-type"><a href="global.html#boolean">boolean</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>If true decimal conversion will be used (by default binary is used).</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line662">line 662</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="getMetadata"><span class="type-signature"></span>getMetadata<span class="signature">(metadataHash, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Retrieves metadata from blob storage.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>hash of metadata.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line567">line 567</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {object} <b>metadata</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="getNewInstance"><span class="type-signature"></span>getNewInstance<span class="signature">()</span><span class="type-signature"> → {<a href="BlobClient.html">BlobClient</a>}</span></h4> <div class="description"> <p>Creates and returns a new instance of a BlobClient with the same settings as the current one. This can be used to avoid issues with the artifacts being book-kept at the instance.</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line110">line 110</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A new instance of a BlobClient</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="BlobClient.html">BlobClient</a></span> </dd> </dl> <h4 class="name" id="getObject"><span class="type-signature"></span>getObject<span class="signature">(metadataHash, callback<span class="signature-attributes">opt</span>, subpath<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Retrieves object from blob storage as a Buffer under node and as an ArrayBuffer in the client. N.B. if the retrieved file is a json-file and running in a browser, the content will be decoded and the string parsed as a JSON.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>hash of metadata for object.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> <tr> <td class="name"><code>subpath</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="description last"><p>optional file-like path to sub-object if complex blob</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line384">line 384</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {Buffer|ArrayBuffer|object} <b>content</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="getObjectAsJSON"><span class="type-signature"></span>getObjectAsJSON<span class="signature">(metadataHash, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Retrieves object from blob storage and parses the content as a JSON. (Will resolve with error if not valid JSON.)</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>hash of metadata for object.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line539">line 539</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {object} <b>contentJSON</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="getObjectAsString"><span class="type-signature"></span>getObjectAsString<span class="signature">(metadataHash, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Retrieves object from blob storage and parses the content as a string.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>hash of metadata for object.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line511">line 511</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {string} <b>contentString</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="getStreamObject"><span class="type-signature"></span>getStreamObject<span class="signature">(metadataHash, writeStream, subpath<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>If running under nodejs and getting large objects use this method to pipe the downloaded object to your provided writeStream.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>metadataHash</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>hash of metadata for object.</p></td> </tr> <tr> <td class="name"><code>writeStream</code></td> <td class="type"> <span class="param-type">stream.Writable</span> </td> <td class="attributes"> </td> <td class="description last"><p>stream the requested data will be piped to.</p></td> </tr> <tr> <td class="name"><code>subpath</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="description last"><p>optional file-like path to sub-object if complex blob</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line487">line 487</a> </li></ul></dd> </dl> <h5>Example</h5> <pre class="prettyprint"><code>// Piping object to the filesystem.. var writeStream = fs.createWriteStream('my.zip'); writeStream.on('error', function (err) { // handle error }); writeStream.on('finish', function () { // my.zip exists at this point }); blobClient.getStreamObject(metadataHash, writeStream);</code></pre> <h4 class="name" id="putFile"><span class="type-signature"></span>putFile<span class="signature">(name, data, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Adds a file to the blob storage.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>name</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> </td> <td class="attributes"> </td> <td class="description last"><p>file name.</p></td> </tr> <tr> <td class="name"><code>data</code></td> <td class="type"> <span class="param-type"><a href="global.html#string">string</a></span> | <span class="param-type">Buffer</span> | <span class="param-type">ArrayBuffer</span> | <span class="param-type">stream.Readable</span> </td> <td class="attributes"> </td> <td class="description last"><p>file content. !ReadStream currently only available from a nodejs setting</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line179">line 179</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {string} <b>metadataHash</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="putFiles"><span class="type-signature"></span>putFiles<span class="signature">(o, callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Adds multiple files to the blob storage.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>o</code></td> <td class="type"> <span class="param-type"><a href="global.html#object">object</a>.<<a href="global.html#string">string</a>, (<a href="global.html#string">string</a>|Buffer|ArrayBuffer)></span> </td> <td class="attributes"> </td> <td class="description last"><p>Keys are file names and values the content.</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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line328">line 328</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {object} <b>fileNamesToMetadataHashes</b>.<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </dd> </dl> <h4 class="name" id="saveAllArtifacts"><span class="type-signature"></span>saveAllArtifacts<span class="signature">(callback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="external-Promise.html">external:Promise</a>}</span></h4> <div class="description"> <p>Saves all the artifacts associated with the current instance.</p> </div> <h5>Parameters:</h5> <table class="params"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <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="attributes"> <optional><br> </td> <td class="description last"><p>if provided no promise will be returned.</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="common_blob_BlobClient.js.html">common/blob/BlobClient.js</a>, <a href="common_blob_BlobClient.js.html#line646">line 646</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>On success the promise will be resolved with {string[]} <b>artifactHashes</b> (metadataHashes).<br> On error the promise will be rejected with <a href="global.html#Error">Error</a> <b>error</b>.</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="external-Promise.html">external:Promise</a></span> </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>