@harishreddym/baqend

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Baqend JavaScript SDK 2.14.1 - Source: lib/binding/Entity.js</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=""> <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">Source: lib/binding/Entity.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; const Managed = require('./Managed'); const EntityPartialUpdateBuilder = require('../partialupdate/EntityPartialUpdateBuilder'); /** * @alias binding.Entity * @extends binding.Managed */ class Entity extends Managed { /** * The default constructor, copy all given properties to this object * @param {Object=} properties - The optional properties to copy * @constructor */ } Object.defineProperties(Entity.prototype, /** @lends binding.Entity.prototype */ { /** * The unique id of this object * * Sets the unique id of this object, if the id is not formatted as an valid id, * it will be used as the key component of the id has the same affect as setting the key * * @type string */ id: { get() { return this._metadata.id; }, set(value) { if (this._metadata.id) { throw new Error('The id can\'t be set twice: ' + value); } const val = value + ''; if (val.indexOf('/db/' + this._metadata.bucket + '/') === 0) { this._metadata.id = value; } else { this.key = value; } }, enumerable: true, }, /** * The unique key part of the id * When the key of the unique id is set an error will be thrown if an id is already set. * @type string */ key: { get() { return this._metadata.key; }, set(value) { this._metadata.key = value; }, }, /** * The version of this object * @type number * @readonly */ version: { get() { return this._metadata.version; }, enumerable: true, }, /** * The object read/write permissions * @type Acl * @readonly */ acl: { get() { return this._metadata.acl; }, enumerable: true, }, /** * Date of the creation of the object * @name createdAt * @readonly * @memberOf binding.Entity.prototype * @type Date */ /** * Last update date of the object * @name updatedAt * @readonly * @memberOf binding.Entity.prototype * @type Date */ /** * Waits on the previously requested operation on this object completes * @param {binding.Entity~doneCallback=} doneCallback The callback which will be invoked when the previously * operations on this object is completed. * @return {Promise<this>} A promise which completes successfully, when the previously requested * operation completes * @method */ ready: { value: function ready(doneCallback) { return this._metadata.ready(doneCallback); }, }, /** * Attach this object to the given db * @param {EntityManager} db The db which will be used for future crud operations * @return {void} * @method */ attach: { value: function attach(db) { db.attach(this); }, }, /** * Saves the object. Inserts the object if it doesn't exists and updates the object if the object exist. * @param {Object} [options] The save options * @param {boolean} [options.force=false] Force the save operation, the version will not be validated. * @param {number|boolean} [options.depth=0] The object depth which will be saved. Depth 0 save this object only, * <code>true</code> saves the objects by reachability. * @param {boolean} [options.refresh=false] Refresh the local object state from remote. * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ save: { value: function save(options, doneCallback, failCallback) { if (options instanceof Function) { return this.save({}, options, doneCallback); } return this._metadata.db.save(this, options).then(doneCallback, failCallback); }, }, /** * Inserts a new object. Inserts the object if it doesn't exists and raise an error if the object already exist. * @param {Object} [options] The insertion options * @param {number|boolean} [options.depth=0] The object depth which will be inserted. Depth 0 insert this object only, * <code>true</code> inserts objects by reachability. * @param {boolean} [options.refresh=false] Refresh the local object state from remote. * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ insert: { value: function insert(options, doneCallback, failCallback) { if (options instanceof Function) { return this.insert({}, options, doneCallback); } return this._metadata.db.insert(this, options).then(doneCallback, failCallback); }, }, /** * Updates an existing object * * Updates the object if it exists and raise an error if the object doesn't exist. * * @param {Object} [options] The update options * @param {boolean} [options.force=false] Force the update operation, * the version will not be validated, only existence will be checked. * @param {number|boolean} [options.depth=0] The object depth which will be updated. Depth 0 updates this object only, * <code>true</code> updates objects by reachability. * @param {boolean} [options.refresh=false] Refresh the local object state from remote. * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ update: { value: function update(options, doneCallback, failCallback) { if (options instanceof Function) { return this.update({}, options, doneCallback); } return this._metadata.db.update(this, options).then(doneCallback, failCallback); }, }, /** * Resolves the referenced object in the specified depth * * Only unresolved objects will be loaded unless the refresh option is specified. * * Removed objects will be marked as removed. * @param {Object} [options] The load options * @param {number|boolean} [options.depth=0] The object depth which will be loaded. Depth set to <code>true</code> * loads objects by reachability. * @param {boolean} [options.refresh=false] Refresh the local object state from remote. * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ load: { value: function load(options, doneCallback, failCallback) { if (options instanceof Function) { return this.load({}, options, doneCallback); } const opt = options || {}; opt.local = true; return this._metadata.db.load(this.id, null, opt).then(doneCallback, failCallback); }, }, /** * Deletes an existing object * * @param {Object} [options] The remove options * @param {boolean} [options.force=false] Force the remove operation, the version will not be validated. * @param {number|boolean} [options.depth=0] The object depth which will be removed. Depth 0 removes this object only, * <code>true</code> removes objects by reachability. * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ delete: { value: function deletee(options, doneCallback, failCallback) { if (options instanceof Function) { return this.delete({}, options, doneCallback); } return this._metadata.db.delete(this, options).then(doneCallback, failCallback); }, }, /** * Saves the object and repeats the operation if the object is out of date * * In each pass the callback will be called. Ths first parameter of the callback is the entity and the second one * is a function to abort the process. * * @param {Function} cb Will be called in each pass * @param {binding.Entity~doneCallback=} doneCallback Called when the operation succeed. * @param {binding.Entity~failCallback=} failCallback Called when the operation failed. * @return {Promise<this>} A Promise that will be fulfilled when the asynchronous operation completes. * @method */ optimisticSave: { value: function optimisticSave(cb, doneCallback, failCallback) { return this._metadata.db.optimisticSave(this, cb).then(doneCallback, failCallback); }, }, attr: { value: function attr() { throw new Error('Attr is not yet implemented.'); }, }, /** * Validates the entity by using the validation code of the entity type * * @return {util.ValidationResult} Contains the result of the Validation * @method */ validate: { value: function validate() { return this._metadata.db.validate(this); }, }, /** * Starts a partial update on this entity * * @param {json=} operations * @return {partialupdate.EntityPartialUpdateBuilder<this>} * @method */ partialUpdate: { value: function partialUpdate(operations) { return new EntityPartialUpdateBuilder(this, operations); }, }, /** * Get all objects which refer to this object * * @param {Object} [options] Some options to pass * @param {Array.<string>} [options.classes] An array of class names to filter for, null for no filter * @return {Promise.<binding.Entity>} A promise resolving with an array of all referencing objects * @method */ getReferencing: { value: function getReferencing(options) { const db = this._metadata.db; const references = this._metadata.type.getReferencing(db, options); // Query all possibly referencing objects const allResults = Array.from(references).map((refAttr) => { // Create query for given entity const ref = refAttr[0]; const qb = db.createQueryBuilder(ref.typeConstructor); // Add term for each attribute const attrs = refAttr[1]; const terms = []; attrs.forEach((attr) => { terms.push(qb.equal(attr, this)); }); // If more than one term, put everything in a disjunction const query = terms.length === 1 ? terms[0] : qb.or(terms); return query.resultList(); }); return Promise.all(allResults).then(results => ( // Filter out all objects which did not match results.filter(result => !!result.length) )).then(results => ( // Flat the array of results [].concat.apply([], results) )); }, }, /** * Converts the object to an JSON-Object * @param {Object|boolean} [options=false] to json options by default excludes the metadata * @param {boolean} [options.excludeMetadata=false] Excludes the metadata form the serialized json * @param {number|boolean} [options.depth=0] Includes up to depth referenced objects into the serialized json * @return {json} JSON-Object * @method */ toJSON: { value: function toJSON(options) { // JSON.stringify calls toJSON with the parent key as the first argument. // Therefore ignore all unknown option types. let opt = options; if (typeof opt === 'boolean') { opt = { excludeMetadata: opt, }; } if (typeof opt !== 'object') { opt = {}; } return this._metadata.getJson(opt); }, }, }); module.exports = Entity; /** * The done callback is called, when the asynchronous operation completes successfully * @callback binding.Entity~doneCallback * @param {this} entity This entity * @return {Promise<*>|*} A Promise, result or undefined */ /** * The fail callback is called, when the asynchronous operation is rejected by an error * @callback binding.Entity~failCallback * @param {error.PersistentError} error The error which reject the operation * @return {Promise<*>|*} A Promise, result or undefined */ </code></pre> </article> </section>  </div> </div> </div> </div> </div> <div id="footer" style="position:relative; z-index:1;"> <div class="container"> <div class="row"> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Product</h4> <a href="https://www.baqend.com/platform.html">Platform</a> <a href="https://www.baqend.com/speedkit.html">Speed Kit</a> <a href="https://www.baqend.com/features.html">Features</a> <a href="https://www.baqend.com/pricing.html">Platform Pricing</a> <a href="https://www.baqend.com/pricing_speedkit.html">Speed Kit Pricing</a> <a href="https://www.baqend.com/agencies.html">Agencies</a> <a href="https://www.baqend.com/enterprise.html">Enterprise</a> <a href="https://www.baqend.com/features.html#download">Community Edition</a> <a href="https://www.baqend.com/support.html">Support</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Company</h4> <a href="https://www.baqend.com/about.html">About us</a> <a href="https://medium.baqend.com">Baqend Blog</a> <a href="https://www.baqend.com/hiring.html">Jobs</a> <a href="https://www.baqend.com/press.html">Press</a> <a href="https://thesis.app.baqend.com/">Bachelor/Master theses</a> <a href="https://www.weblabs.hamburg/">WebLabs.Hamburg</a> </div> <div class="col-xs-6 col-sm-3 sitemap"> <h4>Developer</h4> <a href="https://dashboard.baqend.com/login">Login</a> <a href="https://dashboard.baqend.com/register">Sign Up</a> <a href="https://www.baqend.com/guide">Developer Docs</a> <a href="https://www.baqend.com/guide/roadmap/">Roadmap</a> <a href="https://www.baqend.com/guide/starter-kits">Starter Kits</a> <a href="https://www.baqend.com/js-sdk/latest/baqend.html">JS SDK</a> <a href="https://stackoverflow.com/questions/tagged/baqend/">Stackoverflow</a> </div> <div class="col-xs-6 col-sm-3 contact"> <h4>Contact</h4> <p class="contact-information"> <span> Baqend GmbH<br /> Stresemannstr. 23<br /> 22769 Hamburg<br /> Germany </span> </p> <p class="contact-information"> Email: <a style="display: inline-block" href="mailto:support@baqend.com">support@baqend.com</a> </p> <p class="contact-information"> Tel: <a style="display: inline-block" href="tel:+494060940539">+49 40 60940539</a> </p> </div> </div> <div class="row"> <div class="col-md-12 text-center social"> <a href="https://twitter.com/baqendcom"><i class="fa fa-twitter fa-fw"></i></a> <a href="https://github.com/Baqend"><i class="fa fa-github fa-fw"></i></a> <a href="https://medium.baqend.com/"><i class="fa fa-medium fa-fw"></i></a> <a href="https://www.facebook.com/baqend"><i class="fa fa-facebook fa-fw"></i></a> <a href="https://www.youtube.com/channel/UCsImg6Ts8UEp6-7LE9CP2-Q"><i class="fa fa-youtube fa-fw"></i></a> </div> </div> </div> <footer> <div class="container"> <div class="legal text-center"> <div> <strong>Baqend JavaScript SDK 2.14.1</strong><br> &copy 2019 Baqend GmbH<br> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun, 06 Jan 2019 05:00:21 GMT </div> <a href="mailto:info@baqend.com">Contact</a> - <a href="https://dashboard.baqend.com/privacy">Privacy Policy</a> - <a href="https://dashboard.baqend.com/terms">Terms of Service</a> - <a href="https://dashboard.baqend.com/imprint">Imprint</a> </div> </div> </footer> </div> <script> prettyPrint(); </script> <script src="https://code.jquery.com/jquery-1.12.1.min.js"></script> <script src="scripts/bootstrap.min.js"> </script> <script src="scripts/linenumber.js"> </script> <script src="scripts/filter.js"> </script> <script data-main="scripts/search.js" src="scripts/require.js"></script> </body> </html>