@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Class: EntityManagerFactory</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="active"><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=""> <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=""><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: EntityManagerFactory</h1> <section> <header> <h2><span class="attribs"><span class="type-signature"></span></span>EntityManagerFactory<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h2> </header> <article> <div class="container-overview"> <h4 class="name" id="EntityManagerFactory"><span class="type-signature"></span>new EntityManagerFactory<span class="signature">(options<span class="signature-attributes">opt</span>)</span><span class="type-signature"></span></h4> <div class="description"> <p>Creates a new EntityManagerFactory connected to the given destination</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>options</code></td> <td class="type"> <span class="param-type">string</span> | <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The destination to connect with, or an options object</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <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>host</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The destination to connect with</p></td> </tr> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 80|443 </td> <td class="description last"><p>The optional destination port to connect with</p></td> </tr> <tr> <td class="name"><code>secure</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p><code>true</code> To use a secure ssl encrypted connection</p></td> </tr> <tr> <td class="name"><code>basePath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "/v1" </td> <td class="description last"><p>The base path of the api</p></td> </tr> <tr> <td class="name"><code>schema</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> null </td> <td class="description last"><p>The serialized schema as json used to initialize the metamodel</p></td> </tr> <tr> <td class="name"><code>tokenStorage</code></td> <td class="type"> <span class="param-type"><a href="util.TokenStorage.html">util.TokenStorage</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The tokenStorage which should be used by this emf</p></td> </tr> <tr> <td class="name"><code>tokenStorageFactory</code></td> <td class="type"> <span class="param-type"><a href="util.TokenStorageFactory.html">util.TokenStorageFactory</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The tokenStorage factory implementation which<br>should be used for token storage</p></td> </tr> <tr> <td class="name"><code>staleness</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 60 </td> <td class="description last"><p>The maximum staleness of objects that are acceptable while reading cached<br>data</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="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line17">line 17</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="util.Lockable.html">util.Lockable</a></li> </ul> <h3 class="subsection-title">Members</h3> <h4 class="name" id="code"><span class="type-signature"></span>code<span class="type-signature"> :<a href="util.Code.html">util.Code</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="util.Code.html">util.Code</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line42">line 42</a> </li></ul></dd> </dl> <h4 class="name" id="connection"><span class="type-signature"></span>connection<span class="type-signature"> :<a href="connector.Connector.html">connector.Connector</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="connector.Connector.html">connector.Connector</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line38">line 38</a> </li></ul></dd> </dl> <h4 class="name" id="isReady"><span class="type-signature"></span>isReady<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Indicates if there is currently no exclusive operation executed<br><code>true</code> If no exclusive lock is hold</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">boolean</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="util.Lockable.html#isReady">util.Lockable#isReady</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Lockable.js.html">lib/util/Lockable.js</a>, <a href="lib_util_Lockable.js.html#line34">line 34</a> </li></ul></dd> </dl> <h4 class="name" id="metamodel"><span class="type-signature"></span>metamodel<span class="type-signature"> :<a href="metamodel.Metamodel.html">metamodel.Metamodel</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="metamodel.Metamodel.html">metamodel.Metamodel</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line40">line 40</a> </li></ul></dd> </dl> <h4 class="name" id="staleness"><span class="type-signature"></span>staleness<span class="type-signature"> :number</span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line128">line 128</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_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line119">line 119</a> </li></ul></dd> </dl> <h4 class="name" id="tokenStorageFactory"><span class="type-signature"></span>tokenStorageFactory<span class="type-signature"> :<a href="util.TokenStorageFactory.html">util.TokenStorageFactory</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="util.TokenStorageFactory.html">util.TokenStorageFactory</a></span> </li> </ul> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line44">line 44</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="configure"><span class="type-signature"></span>configure<span class="signature">(options)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Apply additional configurations to this EntityManagerFactory</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>options</code></td> <td class="type"> <span class="param-type">Object</span> </td> <td class="description last"><p>The additional configuration options</p></td> </tr> <tr> <td colspan="4" class="subparams"> <h6>Properties</h6> <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>tokenStorage</code></td> <td class="type"> <span class="param-type"><a href="util.TokenStorage.html">util.TokenStorage</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The tokenStorage which should be used by this emf</p></td> </tr> <tr> <td class="name"><code>tokenStorageFactory</code></td> <td class="type"> <span class="param-type"><a href="util.TokenStorageFactory.html">util.TokenStorageFactory</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> </td> <td class="description last"><p>The tokenStorage factory implementation which<br>should be used for token storage</p></td> </tr> <tr> <td class="name"><code>staleness</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 60 </td> <td class="description last"><p>The maximum staleness of objects that are acceptable while reading cached<br>data, <code>0</code> to always bypass the browser cache</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="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line112">line 112</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="connect"><span class="type-signature"></span>connect<span class="signature">(hostOrApp, port<span class="signature-attributes">opt</span>, secure<span class="signature-attributes">opt</span>, basePath<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<this>}</span></h4> <div class="description"> <p>Connects this EntityManager to the given destination</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>hostOrApp</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The host or the app name to connect with</p></td> </tr> <tr> <td class="name"><code>port</code></td> <td class="type"> <span class="param-type">number</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> 80|443 </td> <td class="description last"><p>The port to connect to</p></td> </tr> <tr> <td class="name"><code>secure</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p><code>true</code> To use a secure connection</p></td> </tr> <tr> <td class="name"><code>basePath</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> "/v1" </td> <td class="description last"><p>The base path of the api</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_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line140">line 140</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<this></span> </dd> </dl> <h4 class="name" id="connect"><span class="type-signature"></span>connect<span class="signature">(hostOrApp, secure<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<this>}</span></h4> <div class="description"> <p>Connects this EntityManager to the given destination</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>hostOrApp</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The host or the app name to connect with</p></td> </tr> <tr> <td class="name"><code>secure</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="default"> false </td> <td class="description last"><p><code>true</code> To use a secure connection</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_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line155">line 155</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<this></span> </dd> </dl> <h4 class="name" id="createEntityManager"><span class="type-signature"></span>createEntityManager<span class="signature">(useSharedTokenStorage<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {<a href="EntityManager.html">EntityManager</a>}</span></h4> <div class="description"> <p>Create a new application-managed EntityManager.</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>useSharedTokenStorage</code></td> <td class="type"> <span class="param-type">boolean</span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The token storage to persist the authorization token, or<br><code>true</code> To use the shared token storage of the emf.<br><code>false</code> To use a instance based storage.</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_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line183">line 183</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>a new entityManager</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="EntityManager.html">EntityManager</a></span> </dd> </dl> <h4 class="name" id="createMetamodel"><span class="type-signature"></span>createMetamodel<span class="signature">()</span><span class="type-signature"> → {<a href="metamodel.Metamodel.html">metamodel.Metamodel</a>}</span></h4> <div class="description"> <p>Creates a new Metamodel instance, which is not connected</p> </div> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManagerFactory.js.html">lib/EntityManagerFactory.js</a>, <a href="lib_EntityManagerFactory.js.html#line170">line 170</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A new Metamodel instance</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type"><a href="metamodel.Metamodel.html">metamodel.Metamodel</a></span> </dd> </dl> <h4 class="name" id="ready"><span class="type-signature"></span>ready<span class="signature">(doneCallback<span class="signature-attributes">opt</span>, failCallback<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<this>}</span></h4> <div class="description"> <p>Waits on the previously requested operation and calls the doneCallback if the operation is fulfilled</p> </div> <h5>Parameters:</h5> <table class="params table"> <thead> <tr> <th>Name</th> <th>Type</th> <th>Attributes</th> <th class="last">Description</th> </tr> </thead> <tbody> <tr> <td class="name"><code>doneCallback</code></td> <td class="type"> <span class="param-type"><a href="util.Lockable.html#~doneCallback">util.Lockable~doneCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>The callback which will be invoked when the previously<br>operations on this object is completed.</p></td> </tr> <tr> <td class="name"><code>failCallback</code></td> <td class="type"> <span class="param-type"><a href="util.Lockable.html#~failCallback">util.Lockable~failCallback</a></span> </td> <td class="attributes"> <optional><br> </td> <td class="description last"><p>When the lock can't be released caused by a none<br>recoverable error</p></td> </tr> </tbody> </table> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="util.Lockable.html#ready">util.Lockable#ready</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_util_Lockable.js.html">lib/util/Lockable.js</a>, <a href="lib_util_Lockable.js.html#line47">line 47</a> </li></ul></dd> </dl> <h5>Returns:</h5> <div class="param-desc"> <p>A promise which completes successfully, when the previously requested<br>operation completes</p> </div> <dl> <dt> Type </dt> <dd> <span class="param-type">Promise.<this></span> </dd> </dl> <h4 class="name" id="withLock%3CT%3E"><span class="type-signature">(protected) </span>withLock<T><span class="signature">(callback, critical<span class="signature-attributes">opt</span>)</span><span class="type-signature"> → {Promise.<T>}</span></h4> <div class="description"> <p>Try to aquire an exclusive lock and executes the given callback.</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>callback</code></td> <td class="type"> <span class="param-type"><a href="util.Lockable.html#~callback">util.Lockable~callback</a></span> </td> <td class="attributes"> </td> <td class="default"> </td> <td class="description last"><p>The exclusive operation to execute</p></td> </tr> <tr> <td class="name"><code>critical</code></t