@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Interface: baqend</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="active"><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">Interface: baqend</h1> <section> <header> <h2>baqend</h2> </header> <article> <div class="container-overview"> <dl class="details"> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_baqend.js.html">lib/baqend.js</a>, <a href="lib_baqend.js.html#line3">line 3</a> </li></ul></dd> </dl> </div> <h3 class="subsection-title">Extends</h3> <ul> <li><a href="EntityManager.html">EntityManager</a></li> </ul> <h3 class="subsection-title">Members</h3> <h4 class="name" id="%5BYourEntityClass:string%5D"><span class="type-signature"></span>[YourEntityClass: string]<span class="type-signature"> :*</span></h4> <div class="description"> <p>An Object factory for entity or embedded objects,<br>that can be accessed by the type name of the entity type.<br>An object factory can be called to create new instances of the type.<br>The created instances implements the <a href="binding.Entity.html"><code>binding.Entity</code></a> or the <a href="binding.Managed.html"><code>binding.Managed</code></a> interface<br>whenever the class is an entity or embedded object</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">*</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#%255BYourEntityClass:string%255D">EntityManager#[YourEntityClass: string]</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1344">line 1344</a> </li></ul></dd> </dl> <h4 class="name" id="bloomFilter"><span class="type-signature">(readonly) </span>bloomFilter<span class="type-signature"> :<a href="caching.BloomFilter.html">caching.BloomFilter</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="caching.BloomFilter.html">caching.BloomFilter</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#bloomFilter">EntityManager#bloomFilter</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line183">line 183</a> </li></ul></dd> </dl> <h4 class="name" id="bloomFilterLock"><span class="type-signature"></span>bloomFilterLock<span class="type-signature"></span></h4> <div class="description"> <p>Bloom filter refresh Promise</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#bloomFilterLock">EntityManager#bloomFilterLock</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line208">line 208</a> </li></ul></dd> </dl> <h4 class="name" id="bloomFilterRefresh"><span class="type-signature">(readonly) </span>bloomFilterRefresh<span class="type-signature"> :number</span></h4> <div class="description"> <p>Bloom filter refresh interval in seconds.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">number</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#bloomFilterRefresh">EntityManager#bloomFilterRefresh</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line202">line 202</a> </li></ul></dd> </dl> <h4 class="name" id="cacheBlackList"><span class="type-signature"></span>cacheBlackList<span class="type-signature"></span></h4> <div class="description"> <p>Set of object ids that were updated but are not yet included in the bloom filter.<br>This set essentially implements revalidation by side effect which does not work in Chrome.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#cacheBlackList">EntityManager#cacheBlackList</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line194">line 194</a> </li></ul></dd> </dl> <h4 class="name" id="cacheWhiteList"><span class="type-signature"></span>cacheWhiteList<span class="type-signature"></span></h4> <div class="description"> <p>Set of object ids that were revalidated after the Bloom filter was loaded.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#cacheWhiteList">EntityManager#cacheWhiteList</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line188">line 188</a> </li></ul></dd> </dl> <h4 class="name" id="code"><span class="type-signature">(readonly) </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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#code">EntityManager#code</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line150">line 150</a> </li></ul></dd> </dl> <h4 class="name" id="Device"><span class="type-signature"></span>Device<span class="type-signature"> :<a href="binding.DeviceFactory.html">binding.DeviceFactory</a></span></h4> <div class="description"> <p>An Device factory for user objects.<br>The Device factory can be called to create new instances of devices or can be used to register, push to and<br>check registration status of devices.</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="binding.DeviceFactory.html">binding.DeviceFactory</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#Device">EntityManager#Device</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1335">line 1335</a> </li></ul></dd> </dl> <h4 class="name" id="deviceMe"><span class="type-signature">(readonly) </span>deviceMe<span class="type-signature"> :<a href="model.Device.html">model.Device</a>|null</span></h4> <div class="description"> <p>The current registered device object</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="model.Device.html">model.Device</a></span> | <span class="param-type">null</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#deviceMe">EntityManager#deviceMe</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line170">line 170</a> </li></ul></dd> </dl> <h4 class="name" id="entityManagerFactory"><span class="type-signature">(readonly) </span>entityManagerFactory<span class="type-signature"> :<a href="EntityManagerFactory.html">EntityManagerFactory</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="EntityManagerFactory.html">EntityManagerFactory</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#entityManagerFactory">EntityManager#entityManagerFactory</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line138">line 138</a> </li></ul></dd> </dl> <h4 class="name" id="File"><span class="type-signature"></span>File<span class="type-signature"> :<a href="binding.FileFactory.html">binding.FileFactory</a></span></h4> <div class="description"> <p>A File factory for file objects.<br>The file factory can be called to create new instances for files.<br>The created instances implements the <a href="binding.File.html"><code>binding.File</code></a> interface</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="binding.FileFactory.html">binding.FileFactory</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#File">EntityManager#File</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1355">line 1355</a> </li></ul></dd> </dl> <h4 class="name" id="isCachingDisabled"><span class="type-signature">(readonly) </span>isCachingDisabled<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Whether caching is disabled</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="EntityManager.html#isCachingDisabled">EntityManager#isCachingDisabled</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line46">line 46</a> </li></ul></dd> </dl> <h4 class="name" id="isDeviceRegistered"><span class="type-signature">(readonly) </span>isDeviceRegistered<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Returns true if the device token is already registered, otherwise false.</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="EntityManager.html#isDeviceRegistered">EntityManager#isDeviceRegistered</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line55">line 55</a> </li></ul></dd> </dl> <h4 class="name" id="isOpen"><span class="type-signature">(readonly) </span>isOpen<span class="type-signature"> :boolean</span></h4> <div class="description"> <p>Determine whether the entity manager is open.<br>true until the entity manager has been closed</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="EntityManager.html#isOpen">EntityManager#isOpen</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line29">line 29</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="log"><span class="type-signature">(readonly) </span>log<span class="type-signature"> :<a href="util.Logger.html">util.Logger</a></span></h4> <div class="description"> <p>Log messages can created by calling log directly as function, with a specific log level or with the helper<br>methods, which a members of the log method.</p> <p>Logs will be filtered by the client logger and the before they persisted. The default log level is<br>'info' therefore all log messages below the given message aren't persisted.</p> <p>Examples:</p> <pre class="prettyprint"> // default log level ist info db.log('test message %s', 'my string'); // info: test message my string // pass a explicit log level as the first argument, one of ('trace', 'debug', 'info', 'warn', 'error') db.log('warn', 'test message %d', 123); // warn: test message 123 // debug log level will not be persisted by default, since the default logging level is info db.log('debug', 'test message %j', {number: 123}, {}); // debug: test message {"number":123} // data = {} // One additional json object can be provided, which will be persisted together with the log entry db.log('info', 'test message %s, %s', 'first', 'second', {number: 123}); // info: test message first, second // data = {number: 123} //use the log level helper db.log.info('test message', 'first', 'second', {number: 123}); // info: test message first second // data = {number: 123} //change the default log level to trace, i.e. all log levels will be persisted, note that the log level can be //additionally configured in the baqend db.log.level = 'trace'; //trace will be persisted now db.log.trace('test message', 'first', 'second', {number: 123}); // info: test message first second // data = {number: 123} </pre> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="util.Logger.html">util.Logger</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#log">EntityManager#log</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line118">line 118</a> </li></ul></dd> </dl> <h4 class="name" id="me"><span class="type-signature">(readonly) </span>me<span class="type-signature"> :<a href="model.User.html">model.User</a>|null</span></h4> <div class="description"> <p>The current logged in user object</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="model.User.html">model.User</a></span> | <span class="param-type">null</span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#me">EntityManager#me</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line163">line 163</a> </li></ul></dd> </dl> <h4 class="name" id="metamodel"><span class="type-signature">(readonly) </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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#metamodel">EntityManager#metamodel</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line144">line 144</a> </li></ul></dd> </dl> <h4 class="name" id="modules"><span class="type-signature">(readonly) </span>modules<span class="type-signature"> :<a href="util.Modules.html">util.Modules</a></span></h4> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="util.Modules.html">util.Modules</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#modules">EntityManager#modules</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line156">line 156</a> </li></ul></dd> </dl> <h4 class="name" id="Role"><span class="type-signature"></span>Role<span class="type-signature"> :<a href="binding.EntityFactory.html">binding.EntityFactory.<model.Role></a></span></h4> <div class="description"> <p>An Role factory for role objects.<br>The Role factory can be called to create new instances of roles, later on users can be attached to roles to manage<br>the access permissions through this role<br>The created instances implements the <a href="model.Role.html"><code>model.Role</code></a> interface</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="binding.EntityFactory.html">binding.EntityFactory.<model.Role></a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#Role">EntityManager#Role</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1325">line 1325</a> </li></ul></dd> </dl> <h4 class="name" id="token"><span class="type-signature"></span>token<span class="type-signature"> :string</span></h4> <div class="description"> <p>The authentication token if the user is logged in currently</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type">string</span> </li> </ul> <dl class="details"> <dt class="tag-overrides">Overrides:</dt> <dd class="tag-overrides"><ul class="dummy"><li> <a href="EntityManager.html#token">EntityManager#token</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line37">line 37</a> </li></ul></dd> </dl> <h4 class="name" id="tokenStorage"><span class="type-signature">(readonly) </span>tokenStorage<span class="type-signature"> :<a href="util.TokenStorage.html">util.TokenStorage</a></span></h4> <div class="description"> <p>Returns the tokenStorage which will be used to authorize all requests.</p> </div> <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="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#tokenStorage">EntityManager#tokenStorage</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line177">line 177</a> </li></ul></dd> </dl> <h4 class="name" id="User"><span class="type-signature"></span>User<span class="type-signature"> :<a href="binding.UserFactory.html">binding.UserFactory</a></span></h4> <div class="description"> <p>An User factory for user objects.<br>The User factory can be called to create new instances of users or can be used to register/login/logout users.<br>The created instances implements the <a href="model.User.html"><code>model.User</code></a> interface</p> </div> <h5>Type:</h5> <ul> <li> <span class="param-type"><a href="binding.UserFactory.html">binding.UserFactory</a></span> </li> </ul> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#User">EntityManager#User</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1316">line 1316</a> </li></ul></dd> </dl> <h3 class="subsection-title">Methods</h3> <h4 class="name" id="addToBlackList"><span class="type-signature"></span>addToBlackList<span class="signature">(objectId)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Adds the given object id to the cacheBlackList if needed.</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>objectId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The id to add.</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="EntityManager.html#addToBlackList">EntityManager#addToBlackList</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1133">line 1133</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="addToWhiteList"><span class="type-signature"></span>addToWhiteList<span class="signature">(objectId)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Adds the given object id to the cacheWhiteList if needed.</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>objectId</code></td> <td class="type"> <span class="param-type">string</span> </td> <td class="description last"><p>The id to add.</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="EntityManager.html#addToWhiteList">EntityManager#addToWhiteList</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line1119">line 1119</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="attach"><span class="type-signature"></span>attach<span class="signature">(entity)</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Attach the instance to this database context, if it is not already attached</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>entity</code></td> <td class="type"> <span class="param-type"><a href="binding.Entity.html">binding.Entity</a></span> </td> <td class="description last"><p>The entity to attach</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="EntityManager.html#attach">EntityManager#attach</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line844">line 844</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="clear"><span class="type-signature"></span>clear<span class="signature">()</span><span class="type-signature"> → {void}</span></h4> <div class="description"> <p>Clear the persistence context, causing all managed entities to become detached</p> <p>Changes made to entities that have not been flushed to the database will not be persisted.</p> </div> <dl class="details"> <dt class="inherited-from">Inherited From:</dt> <dd class="inherited-from"><ul class="dummy"><li> <a href="EntityManager.html#clear">EntityManager#clear</a> </li></ul></dd> <dt class="tag-source">Source:</dt> <dd class="tag-source"><ul class="dummy"><li> <a href="lib_EntityManager.js.html">lib/EntityManager.js</a>, <a href="lib_EntityManager.js.html#line361">line 361</a> </li></ul></dd> </dl> <h5>Returns:</h5> <dl> <dt> Type </dt> <dd> <span class="param-type">void</span> </dd> </dl>