You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.
Dismiss alert
The CloudBoost API is organized around <ahref="http://en.wikipedia.org/wiki/Representational_State_Transfer">REST</a>. Our API is designed to have predictable, resource-oriented URLs and to use HTTP response codes to indicate API errors. We use built-in HTTP features, like HTTP authentication and HTTP verbs, which can be understood by off-the-shelf HTTP clients, and we support <ahref="http://en.wikipedia.org/wiki/Cross-origin_resource_sharing">cross-origin resource sharing</a> to allow you to interact securely with our API from a client-side web application / mobile application (though you should remember that you should never expose your secret API master key in any public website's client-side code, Client Key can be exposed). <ahref="http://www.json.org/">JSON</a> will be returned in all responses from the API, including errors (though if you're using API bindings / SDK, we will convert the response to the appropriate language-specific object).
In Cloudboost, you create an app each of which has its own AppID, Java
Client Key and the Master Key that you apply to your web app. You master key is a secret which should not be shared in your client apps. Your account on CloudBoost can accommodate multiple apps.
This is useful even if you have one application, since you can deploy different versions for test and production.
Your data in CloudBoost is represented with CloudObjects <code>CloudObject</code>. Each <code>CloudObject</code>
belongs to a table in your database with us and each objct represents a row of data in that table. The data you can store in CloudObject has schema which you define in Table Designer in CloudBoost portal. You
simply set whatever key-value pairs you want, and our backend will store it for you.
<ddclass="">string <span>The name of the table you want to deal with</span></dd>
<divclass="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>It returns an instance of a CloudObject, because its a constructor. </p>
</div>
<divclass="method-list">
<h6>Properties</h6>
<p>Every instance of CloudObject has these properties </p>
<dlclass="argument-list">
<dt>id</dt>
<ddclass="">string <span>The id of the CloudObject which is populated after the object is saved.</span></dd>
<divclass="clearfix"></div>
<dt>createdAt</dt>
<ddclass="">Date <span>The Date and time when the object was saved in the database.</span></dd>
<divclass="clearfix"></div>
<dt>updatedAt</dt>
<ddclass="">Date <span>The Date and time when the object was updated in the database.</span></dd>
<divclass="clearfix"></div>
<dt>isSearchable</dt>
<ddclass="">boolean <span>Set this to true if you want this object to be indexe for search and is accessible with CloudSearch</span></dd>
<divclass="clearfix"></div>
<dt>ACL</dt>
<ddclass="">ACL <span>Access Control List, by defualt this object is publicily readbale and writable. You set object leevel security here. Refer ACL's</span></dd>
Realtime Notifications : Listens to <code>CloudObject</code> events like insert, update, delete in the database.
</p>
<divclass="method-list">
<h6>Argument</h6>
<dlclass="argument-list">
<dt>tableName</dt>
<ddclass="">String <span> Name of the table on which you want to listen for events.
respective response.</span></dd>
<divclass="clearfix"></div>
<dt>eventType</dt>
<ddclass="">String / Array<span> Type of an event you want to listen to, Only <code> created, updated, deleted </code> are supported values.</span></dd>
<divclass="clearfix"></div>
<dt>functiontoFire</dt>
<ddclass="">Function <span> Your custom function to fire when the event occours</dd>
Realtime Notifications : Switches off listening to <code>CloudObject</code> events like insert, update, delete in the database.
</p>
<divclass="method-list">
<h6>Argument</h6>
<dlclass="argument-list">
<dt>tableName</dt>
<ddclass="">String <span> Name of the table on which you want to stop listening for events to.
respective response.</span></dd>
<divclass="clearfix"></div>
<dt>eventType</dt>
<ddclass="">String / Array<span> Type of an event you want to stop listening to, Only <code> created, updated, deleted </code> are supported values.</span></dd>
If you want to model one-to-one relationship. Then you need to create a new column of type <code> Relation </code> pointed to a table which you want it to be related to and set that column <code> Unique </code> property to true.
If you want to model one-to-many relationship. Then you need to create a new column of type <code> Relation </code> pointed to a table which you want it to be related to and set that column <code> Unique </code> property to false.
If you want to model many-to-many relationship. Then you have two options<br/>
<ol>
<li><b>#1 - Relation Option</b></li>
<li><b>#2 - List Option</b></li>
</ol>
We will discuss both of these options below. <br/><br/><br/>
<h4>Relation Option</h4>
<p> This option is recommended only if you have huge number of relationships assigned to any one object. </p>
<p> This relationship can be created by creating a third table and having two columns that are relatied to tables you want to have many to many relationships on. </p>
<br/><br/><br/><br/><br/><br/><br/><br/>
<h4>List Option</h4>
<p> This option is recommended only if you have small number of relationships assigned to any one object. </p>
<p> This relationship can be created by creating an array and having related objects pushed to that array and having that array saved in any column of the table. </p>