@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Class: Message</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script>  <link rel="shortcut icon" type="image/x-icon" href="img/favicon.ico"> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/bootstrap-baqend.min.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> <link type="text/css" rel="stylesheet" href="styles/font-awesome-4.7.0.css"> </head> <body> <nav class="navbar navbar-default navbar-fixed-top" role="navigation"> <div class="navbar-inner container">  <div class="navbar-header">  <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse"> <span class="sr-only">Toggle navigation</span> <span class="icon-bar"></span> <span class="icon-bar"></span> <span class="icon-bar"></span> </button>  <a class="navbar-brand" href="/"><img src="img/logo.png"></a> </div>  <div id="nav" class="navbar-collapse collapse">  <form class="navbar-right form-inline search-form"> <div class="form-group search-form-group"> <input type="search" class="form-control search-input" id="search-query" placeholder="Search Guide" name="q" autocomplete="off"> <div id="search-results" class="search-results"> <p class="search-no-results">Please enter a search query ...</p> </div> <i class="search-icon fa fa-search"></i> </div> </form>  <ul class="nav navbar-nav"> <li> <a href="https://dashboard.baqend.com/">Dashboard</a> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Guide <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/">Home</a></li> <li><a href="https://www.baqend.com/guide/#speed-kit">Speed Kit</a></li> <li><a href="https://www.baqend.com/guide/#platform">Platform</a></li> <li><a href="https://www.baqend.com/guide/roadmap/">Roadmap</a></li> <li><a href="https://www.baqend.com/guide/topics/faq/">FAQ</a></li> </ul> </li>  <li class="dropdown"> <a href="#" class="dropdown-toggle" data-toggle="dropdown">Starter Kits <b class="caret"></b></a> <ul class="dropdown-menu"> <li><a href="https://www.baqend.com/guide/starter-kits/">Starter Kits Overview</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/angular2/">Angular 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/react/">React and Redux Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/bootstrap/">Bootstrap Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic2/">Ionic 2 Starter Kit</a></li> <li><a href="https://www.baqend.com/guide/starter-kits/ionic/">Ionic Starter Kit</a></li> </ul> </li> <li class="active"> <a href="baqend.html">JS API</a> </li> <li> <a href="https://www.baqend.com/tutorial.html">Tutorial</a> </li> </ul> </div> </div> </nav> <div class="box gray pt-32 pb-32"> <div class="container"> <div class="row">  <div class="bs-sidebar hidden-print fixed affix" role="complementary"> <input class="filter form-control input-sm" type="text" placeholder="FILTER"/> <ul class="nav bs-sidenav"> <li class=""><a href="Acl.html" class="nav-name">Acl</a></li> <li class=""><a href="EntityManager.html" class="nav-name">EntityManager</a></li> <li class=""><a href="EntityManagerFactory.html" class="nav-name">EntityManagerFactory</a></li> <li class=""><a href="GeoPoint.html" class="nav-name">GeoPoint</a></li> <li class=""><a href="RealtimeEvent.html" class="nav-name">RealtimeEvent</a></li> <li class=""><a href="baqend.html" class="nav-name">baqend</a></li> <li class=""> <a href="binding.html" class="nav-name">binding</a> <ul class="nav"> <li class=""><a href="binding.Accessor.html" class="nav-name">Accessor</a></li> <li class=""><a href="binding.DeviceFactory.html" class="nav-name">DeviceFactory</a></li> <li class=""><a href="binding.Enhancer.html" class="nav-name">Enhancer</a></li> <li class=""><a href="binding.Entity.html" class="nav-name">Entity</a></li> <li class=""><a href="binding.EntityFactory.html" class="nav-name">EntityFactory</a></li> <li class=""><a href="binding.Factory.html" class="nav-name">Factory</a></li> <li class=""><a href="binding.File.html" class="nav-name">File</a></li> <li class=""><a href="binding.FileFactory.html" class="nav-name">FileFactory</a></li> <li class=""><a href="binding.Managed.html" class="nav-name">Managed</a></li> <li class=""><a href="binding.ManagedFactory.html" class="nav-name">ManagedFactory</a></li> <li class=""><a href="binding.Role.html" class="nav-name">Role</a></li> <li class=""><a href="binding.User.html" class="nav-name">User</a></li> <li class=""><a href="binding.UserFactory.html" class="nav-name">UserFactory</a></li> </ul> </li> <li class=""> <a href="caching.html" class="nav-name">caching</a> <ul class="nav"> <li class=""><a href="caching.BloomFilter.html" class="nav-name">BloomFilter</a></li> </ul> </li> <li class="active"> <a href="connector.html" class="nav-name">connector</a> <ul class="nav"> <li class=""><a href="connector.Connector.html" class="nav-name">Connector</a></li> <li class=""><a href="connector.FetchConnector.html" class="nav-name">FetchConnector</a></li> <li class=""><a href="connector.IFrameConnector.html" class="nav-name">IFrameConnector</a></li> <li class="active"><a href="connector.Message.html" class="nav-name">Message</a></li> <li class=""><a href="connector.NodeConnector.html" class="nav-name">NodeConnector</a></li> <li class=""><a href="connector.ObservableStream.html" class="nav-name">ObservableStream</a></li> <li class=""><a href="connector.WebSocketConnector.html" class="nav-name">WebSocketConnector</a></li> <li class=""><a href="connector.XMLHttpConnector.html" class="nav-name">XMLHttpConnector</a></li> <li class=""><a href="connector.ChannelMessage.html" class="nav-name">ChannelMessage</a></li> </ul> </li> <li class=""> <a href="error.html" class="nav-name">error</a> <ul class="nav"> <li class=""><a href="error.CommunicationError.html" class="nav-name">CommunicationError</a></li> <li class=""><a href="error.EntityExistsError.html" class="nav-name">EntityExistsError</a></li> <li class=""><a href="error.IllegalEntityError.html" class="nav-name">IllegalEntityError</a></li> <li class=""><a href="error.PersistentError.html" class="nav-name">PersistentError</a></li> <li class=""><a href="error.RollbackError.html" class="nav-name">RollbackError</a></li> </ul> </li> <li class=""> <a href="metamodel.html" class="nav-name">metamodel</a> <ul class="nav"> <li class=""><a href="metamodel.Attribute.html" class="nav-name">Attribute</a></li> <li class=""><a href="metamodel.BasicType.html" class="nav-name">BasicType</a></li> <li class=""><a href="metamodel.CollectionAttribute.html" class="nav-name">CollectionAttribute</a></li> <li class=""><a href="metamodel.DbIndex.html" class="nav-name">DbIndex</a></li> <li class=""><a href="metamodel.EmbeddableType.html" class="nav-name">EmbeddableType</a></li> <li class=""><a href="metamodel.EntityType.html" class="nav-name">EntityType</a></li> <li class=""><a href="metamodel.ListAttribute.html" class="nav-name">ListAttribute</a></li> <li class=""><a href="metamodel.ManagedType.html" class="nav-name">ManagedType</a></li> <li class=""><a href="metamodel.MapAttribute.html" class="nav-name">MapAttribute</a></li> <li class=""><a href="metamodel.Metamodel.html" class="nav-name">Metamodel</a></li> <li class=""><a href="metamodel.ModelBuilder.html" class="nav-name">ModelBuilder</a></li> <li class=""><a href="metamodel.PluralAttribute.html" class="nav-name">PluralAttribute</a></li> <li class=""><a href="metamodel.SetAttribute.html" class="nav-name">SetAttribute</a></li> <li class=""><a href="metamodel.SingularAttribute.html" class="nav-name">SingularAttribute</a></li> <li class=""><a href="metamodel.Type.html" class="nav-name">Type</a></li> </ul> </li> <li class=""> <a href="model.html" class="nav-name">model</a> <ul class="nav"> <li class=""><a href="model.Device.html" class="nav-name">Device</a></li> <li class=""><a href="model.Role.html" class="nav-name">Role</a></li> <li class=""><a href="model.User.html" class="nav-name">User</a></li> </ul> </li> <li class=""> <a href="partialupdate.html" class="nav-name">partialupdate</a> <ul class="nav"> <li class=""><a href="partialupdate.EntityPartialUpdateBuilder.html" class="nav-name">EntityPartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.PartialUpdateBuilder.html" class="nav-name">PartialUpdateBuilder</a></li> <li class=""><a href="partialupdate.UpdateOperation.html" class="nav-name">UpdateOperation</a></li> </ul> </li> <li class=""> <a href="query.html" class="nav-name">query</a> <ul class="nav"> <li class=""><a href="query.Builder.html" class="nav-name">Builder</a></li> <li class=""><a href="query.Filter.html" class="nav-name">Filter</a></li> <li class=""><a href="query.Node.html" class="nav-name">Node</a></li> <li class=""><a href="query.Operator.html" class="nav-name">Operator</a></li> <li class=""><a href="query.Query.html" class="nav-name">Query</a></li> <li class=""><a href="query.Stream.html" class="nav-name">Stream</a></li> <li class=""><a href="query.Condition.html" class="nav-name">Condition</a></li> </ul> </li> <li class=""> <a href="util.html" class="nav-name">util</a> <ul class="nav"> <li class=""><a href="util.Code.html" class="nav-name">Code</a></li> <li class=""><a href="util.Lockable.html" class="nav-name">Lockable</a></li> <li class=""><a href="util.Logger.html" class="nav-name">Logger</a></li> <li class=""><a href="util.Metadata.html" class="nav-name">Metadata</a></li> <li class=""><a href="util.Modules.html" class="nav-name">Modules</a></li> <li class=""><a href="util.Permission.html" class="nav-name">Permission</a></li> <li class=""><a href="util.PushMessage.html" class="nav-name">PushMessage</a></li> <li class=""><a href="util.TokenStorage.html" class="nav-name">TokenStorage</a></li> <li class=""><a href="util.ValidationResult.html" class="nav-name">ValidationResult</a></li> <li class=""><a href="util.Validator.html" class="nav-name">Validator</a></li> <li class=""><a href="util.TokenStorageFactory.html" class="nav-name">TokenStorageFactory</a></li> </ul> </li> </ul> </div> <div class="col-md-12" id="main"> <div class="content"> <h1 class="page-title">Class: Message</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span> <span class="ancestors"><a href="connector.html">connector</a>.</span>Message<span class="signature">()</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="Message"><span class="type-signature"></span>new Message<span class="signature">()</span><span class="type-signature"></span></h4> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>arguments...</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The path arguments</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line19">line 19</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Members</h3> <h4 class="name" id=".StatusCode"><span class="type-signature">(static) </span>StatusCode<span class="type-signature"> :number</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">number</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>NOT_MODIFIED</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>BAD_CREDENTIALS</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>BUCKET_NOT_FOUND</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>INVALID_PERMISSION_MODIFICATION</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>INVALID_TYPE_VALUE</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OBJECT_NOT_FOUND</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>OBJECT_OUT_OF_DATE</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>PERMISSION_DENIED</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>QUERY_DISPOSED</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>QUERY_NOT_SUPPORTED</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SCHEMA_NOT_COMPATIBLE</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SCHEMA_STILL_EXISTS</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SYNTAX_ERROR</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TRANSACTION_INACTIVE</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TYPE_ALREADY_EXISTS</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>TYPE_STILL_REFERENCED</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>SCRIPT_ABORTION</code></td> <td class="type"> <span class="param-type">number</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="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line457">line 457</a> </li></ul></dd> </dl> <h4 class="name" id="progressCallback"><span class="type-signature"></span>progressCallback<span class="type-signature"> :<a href="connector.Message.html#~progressCallback">connector.Message~progressCallback</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="connector.Message.html#~progressCallback">connector.Message~progressCallback</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line86">line 86</a> </li></ul></dd> </dl> <h4 class="name" id="spec"><span class="type-signature"></span>spec<span class="type-signature"> :Object</span></h4> <div class="description"> <p>The message specification</p> </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="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line445">line 445</a> </li></ul></dd> </dl> <h4 class="name" id="tokenStorage"><span class="type-signature"></span>tokenStorage<span class="type-signature"> :<a href="util.TokenStorage.html">util.TokenStorage</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="util.TokenStorage.html">util.TokenStorage</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line83">line 83</a> </li></ul></dd> </dl> <h4 class="name" id="withCredentials"><span class="type-signature"></span>withCredentials<span class="type-signature"> :boolean</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line80">line 80</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">(specification)</span><span class="type-signature"> → {Class.<Message>}</span></h4> <div class="description"> <p>Creates a new message class with the given message specification</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>specification</code></td> <td class="type"> <span class="param-type">Object</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="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line25">line 25</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Class.<Message></span> </dd> </dl> <h4 class="name" id=".createExternal"><span class="type-signature">(static) </span>createExternal<span class="signature">(specification, members)</span><span class="type-signature"> → {Class.<Message>}</span></h4> <div class="description"> <p>Creates a new message class with the given message specification and a full path</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>specification</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"></td> </tr> <tr> <td class="name"><code>members</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>additional members applied to the created message</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line54">line 54</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Class.<Message></span> </dd> </dl> <h4 class="name" id="accept"><span class="type-signature"></span>accept<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> <p>Gets the request accept header</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line335">line 335</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="accept"><span class="type-signature"></span>accept<span class="signature">(accept)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets the request accept header</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>accept</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>the accept header value</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line348">line 348</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="acl"><span class="type-signature"></span>acl<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> <p>Gets the ACL of a file into the Baqend-Acl header</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line301">line 301</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="acl"><span class="type-signature"></span>acl<span class="signature">(acl)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets and encodes the ACL of a file into the Baqend-Acl header</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>acl</code></td> <td class="type"> <span class="param-type"><a href="Acl.html">Acl</a></span> </td> <td class="description last"><p>the file ACLs</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line314">line 314</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="addQueryString"><span class="type-signature"></span>addQueryString<span class="signature">(query)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Adds the given string to the request path</p> <p>If the parameter is an object, it will be serialized as a query string.</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>query</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Object.<string, string></span> </td> <td class="description last"><p>which will added to the request path</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line404">line 404</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="cacheControl"><span class="type-signature"></span>cacheControl<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> <p>Gets the cache control header</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line284">line 284</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="cacheControl"><span class="type-signature"></span>cacheControl<span class="signature">(value)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets the cache control header</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>value</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The cache control flags</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line297">line 297</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="signature">()</span><span class="type-signature"> → {number}</span></h4> <div class="description"> <p>Gets the contentLength</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line202">line 202</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">number</span> </dd> </dl> <h4 class="name" id="contentLength"><span class="type-signature"></span>contentLength<span class="signature">(contentLength)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets the contentLength</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>contentLength</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="description last"><p>the content length of the data</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line215">line 215</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="customHeaders"><span class="type-signature"></span>customHeaders<span class="signature">()</span><span class="type-signature"> → {string}</span></h4> <div class="description"> <p>Gets and encodes the custom headers of a file into the Baqend-Custom-Headers header</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line318">line 318</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">string</span> </dd> </dl> <h4 class="name" id="customHeaders"><span class="type-signature"></span>customHeaders<span class="signature">(customHeaders)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets and encodes the custom headers of a file into the Baqend-Custom-Headers header</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>customHeaders</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="description last"><p>the file custom headers</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line331">line 331</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>This message object</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">this</span> </dd> </dl> <h4 class="name" id="doReceive"><span class="type-signature"></span>doReceive<span class="signature">(response)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Handle the receive</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>response</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The received response headers and data</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Message.js.html#line438">line 438</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl> <h4 class="name" id="entity"><span class="type-signature"></span>entity<span class="signature">(data, type<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {this}</span></h4> <div class="description"> <p>Sets the entity type</p> </div> <h5>Parameters:</h5> <table class="params table"> <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>data</code></td> <td class="type"> <span class="param-type">*</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The data to send</p></td> </tr> <tr> <td class="name"><code>type</code></td> <td class="type"> <span class="param-type"><a href="global.html#EntityType">EntityType</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "json" </td> <td class="description last"><p>the type of the data one of 'json'|'text'|'blob'|'arraybuffer' defaults to 'json'</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_connector_Message.js.html">lib/connector/Message.js</a>, <a href="lib_connector_Mess