dotnet.html

<!DOCTYPE html>
<html lang="en">

<meta http-equiv="content-type" content="text/html;charset=utf-8" />
<head>
    <meta charset="utf-8" />
    <title>CloudBoost SDK Reference</title>
    <link rel="shortcut icon" href="/favicon.ico" type="image/x-icon">

    <link rel="stylesheet" type="text/css" href="assets/css/site.css" media="screen" />   

    <script src="assets/js/qframe.js"></script>
    <script src="assets/js/jquery.js"></script>
    <script src="assets/js/jquery.cookie.js"></script>
    <script src="assets/js/waypoints.js"></script>
    <script src="assets/js/shared.js"></script>
    <script src="assets/js/api.js"></script>
    <!-- start Mixpanel -->
    <script type="text/javascript">(function(f,b){if(!b.__SV){var a,e,i,g;window.mixpanel=b;b._i=[];b.init=function(a,e,d){function f(b,h){var a=h.split(".");2==a.length&&(b=b[a[0]],h=a[1]);b[h]=function(){b.push([h].concat(Array.prototype.slice.call(arguments,0)))}}var c=b;"undefined"!==typeof d?c=b[d]=[]:d="mixpanel";c.people=c.people||[];c.toString=function(b){var a="mixpanel";"mixpanel"!==d&&(a+="."+d);b||(a+=" (stub)");return a};c.people.toString=function(){return c.toString(1)+".people (stub)"};i="disable track track_pageview track_links track_forms register register_once alias unregister identify name_tag set_config people.set people.set_once people.increment people.append people.union people.track_charge people.clear_charges people.delete_user".split(" ");
      for(g=0;g<i.length;g++)f(c,i[g]);b._i.push([a,e,d])};b.__SV=1.2;a=f.createElement("script");a.type="text/javascript";a.async=!0;a.src="undefined"!==typeof MIXPANEL_CUSTOM_LIB_URL?MIXPANEL_CUSTOM_LIB_URL:"//cdn.mxpnl.com/libs/mixpanel-2-latest.min.js";e=f.getElementsByTagName("script")[0];e.parentNode.insertBefore(a,e)}})(document,window.mixpanel||[]);
      mixpanel.init("be05a4d590e8bc9d5f2cd6b3b3ffb78b");</script>
    <!-- end Mixpanel --> 

</head>

<body class="api-docs node">
  <div id="background"></div>
    <div id="header">
      <a href="https://www.cloudboost.io">
        <img src="assets/images/logoc81e.png" height="40" style="float:left;margin-top:5px" />
      </a>
      <div class="navigation">
        <div class="signin">
          <a id='signin' href="https://dashboard.cloudboost.io/accounts">
            <span>Sign In</span>
          </a>
        </div>
        <ul class="global">
          <li><a href="https://docs.cloudboost.io" class="selected">Documentation</a></li>
          <li><a href="https://cloudboost.io/quickstart" target="_blank">Quickstart</a></li>
          <li><a href="http://stackoverflow.com/questions/ask?tags=cloudboost" target="_blank">Help &amp; Support</a></li>
        </ul>
      </div>
    </div>

    <div id="guide">
    <p class="ref-title">Overview</p>
    <ul class="ref-list">
      <li class="section">
        <a href="#Introduction" class="parent viewing">Introduction</a>
      </li>
      <li class="section">
          <a href="#Dependencies" class="parent">Dependencies</a>
        </li>
      <li class="section">
        <a href="#Apps" class="parent">Apps</a>
      </li>
    </ul>

      <p class="ref-title">Features</p>
      <ul class="ref-list">

        <li class="section section-charges">
          <a href="#CloudApp" class="parent">App</a>
          <span class="children">
            <a href="#CloudApp-init" class="parent">Initialize App</a>
          </span>
        </li>

        <li class="section section-charges">
          <a href="#CloudObject" class="parent">Object</a>
          <span class="children">
            <a href="#CloudObject-constructor" class="parent">Constructor</a>
            <a href="#CloudObject-set" class="parent">Set</a>
            <a href="#CloudObject-get" class="parent">Get</a>
            <a href="#CloudObject-unset" class="parent">Unset</a>
            <a href="#CloudObject-save" class="parent">Save</a>
            <a href="#CloudObject-fetch" class="parent">Fetch</a>
            <a href="#CloudObject-delete" class="parent">Delete</a>
            <a href="#CloudObject-on" class="parent">On</a>
            <a href="#CloudObject-off" class="parent">Off</a>
            <a href="#CloudObject-expires" class="parent">Expires</a>
            <a href="#CloudObject-relate" class="parent">Relate</a>
          </span>
        </li>
        <li class="section section-charges"><a href="#Relationships" class="parent">Relationships</a>
          <span class="children">
            <a href="#Relationships-oneToOne" class="parent">One-to-One</a>
            <a href="#Relationships-oneToMany" class="parent">One-to-Many</a>
            <a href="#Relationships-manyToMany" class="parent">Many-to-many</a>
            <a href="#Relationships-query" class="parent">Query on Relationships</a>
          </span>
        </li>

        <li class="section section-charges"><a href="#CloudQuery" class="parent">Query</a>
          <span class="children">
            <a href="#CloudQuery-constructor" class="parent">Constructor</a>
            <a href="#CloudQuery-equalTo" class="parent">Equal To</a>
            <a href="#CloudQuery-notEqualTo" class="parent">Not Equal To</a>
            <a href="#CloudQuery-containedIn" class="parent">Contained In</a>
            <a href="#CloudQuery-containsAll" class="parent">Contains All</a>
            <a href="#CloudQuery-notContainedIn" class="parent">Not Contained In</a>
            <a href="#CloudQuery-greaterThan" class="parent">Greater Than</a>
            <a href="#CloudQuery-greaterThanEqualTo" class="parent">Greater Than and Equal To</a>
            <a href="#CloudQuery-lessThan" class="parent">Less Than</a>
            <a href="#CloudQuery-lessThanEqualTo" class="parent">Less than and equal to</a>
            <a href="#CloudQuery-startsWith" class="parent">Starts With</a>
            <a href="#CloudQuery-or" class="parent">Or</a>
            <a href="#CloudQuery-orderByAsc" class="parent">Order by</a>
            <a href="#CloudQuery-setLimit" class="parent">Limit</a>
            <a href="#CloudQuery-setSkip" class="parent">Skip</a>
            <a href="#CloudQuery-selectColumn" class="parent">Select Column</a>
            <a href="#CloudQuery-doNotSelectColumn" class="parent">Do Not Select Column</a>
            <a href="#CloudQuery-exists" class="parent">Exists</a>
            <a href="#CloudQuery-doesNotExists" class="parent">Does not exist</a>
            <a href="#CloudQuery-find" class="parent">Find</a>
            <a href="#CloudQuery-findOne" class="parent">Find One</a>
            <a href="#CloudQuery-get" class="parent">Find By Id</a>
            <a href="#CloudQuery-count" class="parent">Count</a>
            <a href="#CloudQuery-distinct" class="parent">Distinct</a>
            <a href="#CloudQuery-include" class="parent">Include</a>
            <a href="#CloudQuery-near" class="parent">Near</a>
            <a href="#CloudQuery-geowithin" class="parent">GeoWithin</a>
          </span>
        </li>

        <li class="section section-charges"><a href="#CloudNotifcations" class="parent">Notifications</a>
          <span class="children">
            <a href="#CloudNotification-on" class="parent">Subscribe</a>
            <a href="#CloudNotification-publish" class="parent">Publish</a>
            <a href="#CloudNotification-off" class="parent">Unsubscribe</a>
          </span>
        </li>

        <li class="section section-charges"><a href="#CloudSearch" class="parent">Search</a>

          <span class="children">
            <a href="#CloudSearch-constructor" class="parent">Constructor</a>

            <a href="#sq-searchOn" class="parent">Query : Search On</a>
            <a href="#sq-phrase" class="parent">Query : Phrase</a>
            <a href="#sq-bestColumns" class="parent">Query : Best Columns</a>
            <a href="#sq-mostColumns" class="parent">Query : Most Columns</a>
            <a href="#sq-startsWith" class="parent">Query : StartsWith</a>
            <a href="#sq-wildcard" class="parent">Query : Wildcard</a>
            <a href="#sq-regexp" class="parent">Query : Regexp</a>
            <a href="#sq-and" class="parent">Query : and</a>
            <a href="#sq-or" class="parent">Query : or</a>
            <a href="#sq-not" class="parent">Query : not</a>

            <a href="#SearchFilter-equalTo" class="parent">Filter : Equal To</a>
            <a href="#SearchFilter-notEqualTo" class="parent">Filter : Not Equal To</a>
            <a href="#SearchFilter-greaterThan" class="parent"> Filter : Greater Than</a>
            <a href="#SearchFilter-greaterThanEqualTo" class="parent"> Filter : Greater Than and Equal To</a>
            <a href="#SearchFilter-lessThan" class="parent"> Filter : Less Than</a>
            <a href="#SearchFilter-lessThanEqualTo" class="parent"> Filter : Less than and equal to</a>
            <a href="#SearchFilter-exists" class="parent"> Filter : Exists</a>
            <a href="#SearchFilter-doesNotExists" class="parent"> Filter : Does not exist</a>
            <a href="#SearchFilter-or" class="parent">Filter : or</a>
            <a href="#SearchFilter-and" class="parent">Filter : and</a>
            <a href="#SearchFilter-not" class="parent">Filter : not</a>

            <a href="#CloudSearch-orderByAsc" class="parent">Order by</a>
            <a href="#CloudSearch-setLimit" class="parent">Limit</a>
            <a href="#CloudSearch-setSkip" class="parent">Skip</a>
            <a href="#CloudSearch-search" class="parent">Search</a>

          </span>
        </li>

        <li class="section section-charges"><a href="#CloudGeoPoint" class="parent">GeoPoint</a>

          <span class="children">
            <a href="#CloudGeoPoint-constructor" class="parent">Constructor</a>
              <a href="#CloudGeoPoint-dkm" class="parent">Distance In kilometers</a>
              <a href="#CloudGeoPoint-miles" class="parent">Distance In Miles</a>
              <a href="#CloudGeoPoint-radians" class="parent">Distance In Radians</a>

          </span>

        </li>

        <li class="section section-charges"><a href="#CloudUser" class="parent">User</a>
          <span class="children">
            <a href="#CloudUser-constructor" class="parent">Constructor</a>
            <a href="#CloudUser-signUp" class="parent">Signup</a>
            <a href="#CloudUser-logIn" class="parent">Login</a>
            <a href="#CloudUser-logOut" class="parent">Logout</a>
            <a href="#CloudUser-addToRole" class="parent">Add To Role</a>
            <a href="#CloudUser-isInRole" class="parent">Is In Role</a>
            <a href="#CloudUser-removeFromRole" class="parent">Remove from Role</a>
          </span>
        </li>

        <li class="section section-charges"><a href="#CloudRole" class="parent">Role</a>
          <span class="children">
            <a href="#CloudRole-constructor" class="parent">Constructor</a>
          </span>
        </li>


        <li class="section section-charges"><a href="#CloudFile" class="parent">File</a>

          <span class="children">
            <a href="#CloudFile-constructor" class="parent">Constructor</a>
            <a href="#CloudFile-save" class="parent">Save</a>
            <a href="#CloudFile-delete" class="parent">Delete</a>
          </span>

        </li>

        <li class="section section-charges">
          <a href="#Column" class="parent">Column</a>
          <span class="children">
            <a href="#Column-constructor" class="parent">Constructor</a>
            <a href="#Column-datatype" class="parent">Data Type</a>
          </span>
        </li>

        <li class="section section-charges">
          <a href="#CloudTable" class="parent">Table</a>
          <span class="children">
            <a href="#CloudTable-constructor" class="parent">Constructor</a>
            <a href="#CloudTable-get" class="parent">Get</a>
            <a href="#CloudTable-getall" class="parent">GetAll</a>
            <a href="#CloudTable-addcolumn" class="parent">Add Column</a>
            <a href="#CloudTable-deletecolumn" class="parent">Delete Column</a>
            <a href="#CloudTable-save" class="parent">Save</a>
            <a href="#CloudTable-delete" class="parent">Delete</a>
          </span>
        </li>

        <li class="section section-charges"><a href="#ACL" class="parent">Access Control List (ACL)</a>
          <span class="children">
            <a href="#ACL-constructor" class="parent">Constructor</a>
            <a href="#ACL-setPublicWriteAccess" class="parent">Public Write Access</a>
            <a href="#ACL-setPublicReadAccess" class="parent">Public Read Access</a>
            <a href="#ACL-setUserWriteAccess" class="parent">User Write Access</a>
            <a href="#ACL-setUserReadAccess" class="parent">User Read Access</a>
            <a href="#ACL-setRoleWriteAccess" class="parent">Role Write Access</a>
            <a href="#ACL-setRoleReadAccess" class="parent">Role Read Access</a>
          </span>
        </li>
        <li class="section section-charges"><a href="#Contribute" class="parent">Contribute</a>
        </li>
      </ul>

    </div>
<!-- api docs -->
<div id="api-docs">
    <a id="top" name="top" class="section-anchor">&nbsp;</a>
      	<div id="methods">
        <div class="border"></div>

        <div id="language">
          <a id="javascript-sdk" class="language" href="javascript.html">JavaScript</a>
          <a id="java-sdk" class="language" href="java.html">Java</a>
          <a id="dotnet-sdk" class="language" href="dotnet.html">.Net</a>
          <a id="curl-sdk" class="language" href="curl.html">cURL</a>
          <a id="others-swagger" class="language" href="swagger">Others</a>
        </div>
 <div class="method">
          <a id='Introduction' name="Introduction" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>API Reference</h1>

              <p>
              The CloudBoost API is organized around <a href="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 <a href="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). <a href="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).
	        </p>
	       
            </div>
            <div class="method-example" id="api-summary-example">

              <h3>.NET SDK</h3>
              
              <h4>Nuget Package :</h4>  <a href="https://www.nuget.org/packages/cloudboost/">
                <code>Install-Package cloudboost</code>
              </a>
              <h4>GitHub :</h4>  <a href="https://github.com/CloudBoost/.net-sdk">
                <code>https://github.com/CloudBoost/.net-sdk</code>
              </a><br/>

            </div>
          </div>
        </div>

        <div class="method">
          <a id='Dependencies' name="Dependencies" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>Dependencies</h1>
              <p>
              This SDK require few external libraries. 
              <ul>
              	<li><a href="">Newsoft Json</a></li>
              	<li><a href="">EngineIoClientDotNet</a></li>
              	<li><a href="">SocketIoClientDotNet</a></li>
                <li><a href="">WebSocket4Net</a></li>
                <li><a href="">log4net</a></li>
              </ul>

              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div> <!-- method-example -->
          </div> <!-- method-section -->
        </div> <!-- method -->
 <div class="method">
          <a id='Apps' name="Apps" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>Apps</h1>
              <p>
              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.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
        </div>
 <div class="method">
          <a id='CloudApp' name="CloudApp" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>CB.CloudApp</h1>
              <p>
              This is your CloudApp object, and it is used to initalize your app with CloudBoost.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
          <a id='CloudApp-init' name="CloudApp-init" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudApp.init( <code>appId, appKey</code> )</h3>
              <p>
              Initialises the app.
              </p>
              <p>
                <i>ClientKey</i> and <i>MasterKey</i> are the two keys that are provided for each app your create.
                If you want a client of your app have access to CloudBoost API, its <b>recommended</b> you only share <i>ClientKey</i> with your app.
                <br/>
                We dont recommend initialising your app with <i>MasterKey</i> unless you install our API and make requests from your server.
              </p>
              <div class="method-list">
                <h3>Package</h3>
                            
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>appId</dt>
                  <dd class="">Application ID <span>with which your app is registered.</span></dd>
                  <div class="clearfix"></div>
                  <dt>appKey</dt>
                  <dd class="">Client/Master key <span>unique for your app</span></dd>
                  <div class="clearfix"></div>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>It doesn't return anything.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js java">

string myAppId = "schoolApp";
string myKey = "d1bae1c6978e3ecd3d5c8a0095767c9c";

CloudApp.init(myAppId, myKey);
              </span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->
        </div> <!-- method -->
<div class="method">
          <a id='CloudObject' name="CloudObject" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h1>CB.CloudObject</h1>
              <p>
              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.
              </p>
			
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
          <a id='CloudObject-constructor' name="CloudObject-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">              
              <h3>Constructor : CloudObject( <code>columnName, [objectId]</code> )</h3>
              <p>
              Instantiates a <code>CloudObject</code> object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>tableName</dt>
                  <dd class="">string <span>The name of the table you want to deal with</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns an instance of a CloudObject, because its a constructor. </p>
              </div>
              <div class="method-list">  
                <h6>Properties</h6>

                <p>Every instance of CloudObject has these properties </p>

                <dl class="argument-list">

                  <dt>id</dt>
                  <dd class="">string <span>The id of the CloudObject which is populated after the object is saved.</span></dd>
                  <div class="clearfix"></div>

                  <dt>createdAt</dt>
                  <dd class="">Date <span>The Date and time when the object was saved in the database.</span></dd>
                  <div class="clearfix"></div>

                   <dt>updatedAt</dt>
                  <dd class="">Date <span>The Date and time when the object was updated in the database.</span></dd>
                  <div class="clearfix"></div>

                  <dt>isSearchable</dt>
                  <dd class="">boolean <span>Set this to true if you want this object to be indexe for search and is accessible with CloudSearch</span></dd>
                  <div class="clearfix"></div>

                  <dt>ACL</dt>
                  <dd class="">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>
                  <div class="clearfix"></div>
                  
                </dl>

                
              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node">
              <span class="highlight_js javascript">
//creates an object for Student table
//all the CloudBoost functionality.
var obj = new CB.CloudObject("Student"); 
              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-set' name="CloudObject-set" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.Set( <code>columnName, data</code> )</h3>
              <p>
              Sets the value of an attribute of a <code>CloudObject</code> object.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be set.</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Any data<span>The value which is to be stored in the column.</span></dd>
                  <div class="clearfix"></div>

                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student"); //create a new object.
obj.Set("name", "John Smith"); //store string
obj.Set("age", 21); // store number
Dictionary&lt;string, object&gt; address = new Dictionary&lt;string,object&gt;();
addressAdd("city","Hyderabad");
address.Add("state", "Telangana");
address.Add("country","India");
address.Add("zip", 500046);
obj.Set("address",address);
                   </span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-get' name="CloudObject-get" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.Get( <code>columnName</code> )</h3>
              <p>
              Gets the value of an column of an instance of <code>CloudObject</code> object.
              </p>
              <div class="method-list">
                <h6>Argument</h6>
                <dl class="argument-list">
                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be fetched.</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>It returns <code>undefined</code> if the attribute is not set previously otherwise 
                returns the value of column which was previously set.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
Dictionary&lt;string,object&gt; getAddressObject = new Dictionary&lt;string,object&gt;();
getAddressObject = (Dictionary<string, Object>)obj.Get("address"); //get the data. 
/* address will be a Dictionary Object 
 
  getAddressObject["city"];
  getAddressObject["state"];
	
  which was saved using object.set
*/
string name = obj.Get("name");


                   </span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-unset' name="CloudObject-unset" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.Unset( <code>columnName</code> )</h3>
              <p>
              Sets the value of an column of a <code>CloudObject</code> object to <code>null</code>.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column which is to be unset.</span></dd>
                  <div class="clearfix"></div>
                  

                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.Set("name", "John Smith");
obj.Get("name"); 
obj.Unset("name");
obj.Get("name"); 
</span></span></code>
             
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-save' name="CloudObject-save" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.SaveAsync()</h3>
              <p>
              Saves the <code>CloudObject</code> object to CloudBoost.
              </p>
              <div class="method-list">
              <h6>Argument</h6>
                <dl class="argument-list">
                <h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
                  <div class="clearfix"></div>
                
                </dl>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.Set("name", "Smith");
await obj.SaveAsync();
</span></span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-fetch' name="CloudObject-fetch" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.FetchAsync()</h3>
              <p>
              Refreshes a <code>CloudObject</code> object to by fetching its values from the database.
              </p>
              <div class="method-list">
              		<h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
                  <div class="clearfix"></div>
                </dl>

                
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
  await obj.FetchAsync();
</span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudObject-delete' name="CloudObject-delete" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.DeleteAsync()</h3>
              <p>
              Delete a <code>CloudObject</code> object, if it is saved in the database.
              </p>
              <div class="method-list">
                <h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
                
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
await obj.DeleteAsync();
              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

           <a id='CloudObject-searchable' name="CloudObject-searchable" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.IsSearchable</h3>
              <p>
              Indexes <code>CloudObject</code> for search using CloudSearch.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
  CloudObject obj = new CB.CloudObject('Student');
  obj.Set("name", "John Smith");
  obj.IsSearchable = true; //index this object for Search
</span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudObject-on' name="CloudObject-on" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.On( <code> tableName, eventType, Callback</code>)</h3>
              <p>
              Realtime Notifications : Listens to  <code>CloudObject</code> events like insert, update, delete in the database.
              </p>
              <div class="method-list">

               <h6>Argument</h6>

                <dl class="argument-list"> 
                  <dt>tableName</dt>
                  <dd class="">String <span> Name of the table on which you want to listen for events.
                   respective response.</span></dd>
                  <div class="clearfix"></div>

                  <dt>eventType</dt>
                  <dd class="">String / Array<span> Type of an event you want to listen to, Only  <code> created, updated, deleted </code> are supported values.</span></dd>
                  <div class="clearfix"></div>

                  <dt>Callback</dt>
                  <dd class="">Function <span> Your custom function to fire when the event occours</dd>
                  <div class="clearfix"></div>
                  
                  <div class="clearfix"></div>
                
                </dl>

                <h6>Returns</h6>
                <p>void</p>

              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
  //listen to an event

 CB.CloudObject.On("Student", "created", new Callback(action));
  void action(Object result){
    //function to fire
  }
</span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


                    <a id='CloudObject-off' name="CloudObject-off" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudObject.Off( <code> tableName, eventType </code>)</h3>
              <p>
              Realtime Notifications : Switches off listening to  <code>CloudObject</code> events like insert, update, delete in the database.
              </p>

              <div class="method-list">

               <h6>Argument</h6>

                <dl class="argument-list"> 
                  <dt>tableName</dt>
                  <dd class="">String <span> Name of the table on which you want to stop listening for events to.
                   respective response.</span></dd>
                  <div class="clearfix"></div>

                  <dt>eventType</dt>
                  <dd class="">String / Array<span> Type of an event you want to stop listening to, Only  <code> created, updated, deleted </code> are supported values.</span></dd>
                  <div class="clearfix"></div>
                  <div class="clearfix"></div>
                
                </dl>

                <h6>Returns</h6>
                <p>void</p>

              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
  //stop listening to an event

  CB.CloudObject.Off("Student", "created");

</span></span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

            <a id='CloudObject-expires' name="CloudObject-expires" class="section-anchor">&nbsp;</a>
            <div class="method-section">
                <div class="method-description">

                    <h3>CloudObject.Expires</h3>
                    <p>
                        Sets the expiration time for <code>CloudObject</code>. Expiration time is to be given as number of
                        milliseconds from 1 Jan 1970.
                    </p>
                </div>
                <div class="method-example" id="api-summary-example">
                    <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.Set("name", "John Smith");
Date date = new Date(2015, 12, 25);
obj.Expires = date.getTime()+1000;
</span></span></span></code>
                </div><!-- method-example -->
            </div> <!-- method-section -->

        </div> <!-- method -->
                <a id='CloudObject-relate' name="CloudObject-relate" class="section-anchor">&nbsp;</a>
            <div class="method-section">
                <div class="method-description">

                    <h3>CloudObject.Relate(<code>columnName,tableName,objectId</code>)</h3>
                    <p>
                        Relates a CloudObject which is already saved to this CloudObject. Can be used to relate objects together in a relation.
                    </p>

                     <div class="method-list">

                   <h6>Argument</h6>

                    <dl class="argument-list"> 
                      <dt>columnName</dt>
                      <dd class="">String <span> Name of the column of the current CloudObject.
                       </span></dd>
                      <div class="clearfix"></div>

                      <dt>tableName</dt>
                      <dd class="">String <span> Name of the table of the CloudObject which you want to relate to.
                       </span></dd>
                      <div class="clearfix"></div>

                      <dt>objectId</dt>
                      <dd class="">String <span> Id of the object which you want to relate to.
                       </span></dd>
                      <div class="clearfix"></div>
                    
                    </dl>

                    <h6>Returns</h6>
                    <p>void</p>

              </div>
                </div>
                <div class="method-example" id="api-summary-example">
                    <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.Relate("teacher","Teacher","xxxxxx""); //relates the teacher in the Teacher table with id xxxxx to this student.
</span></span></span></code>
                </div><!-- method-example -->
            </div> <!-- method-section -->

        <div class="method">
          <a id='Relationships' name="Relationships" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>Relationships</h1>

              <p>
                This section is dedicated to modelling relationships with CloudBoost.
              </p>
              <p>
                There are usually three types of relationships. 
                <ul>
                  <li> 
                    One-to-One Relationship
                  </li>
                  <li> 
                    One-to-many Relationship
                  </li>
                  <li> 
                    Many-to-many Relationship
                  </li>
                </ul>
              </p>

            </div>
            <div class="method-example" id="api-summary-example">
            </div> <!-- method-example -->
          </div><!-- method-section -->

          <a id='Relationships-oneToOne' name="Relationships-oneToOne" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>One-to-One Relationship</h3>
              <p>
                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.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var student = new CB.CloudObject("Student"); 
var address = new CB.CloudObject("Address"); 

//here one student can only have one address for example. 
//address column of Student Table is pointed to the Address Table with unique set to true.
student.Set("address", address); 

await student.SaveAsync();
              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='Relationships-oneToMany' name="Relationships-oneToMany" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>One-to-Many Relationship</h3>
               <p>
                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.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var teacher = new CB.CloudObject("Teacher"); 
var course = new CB.CloudObject("Course"); 

//here one teacher be assigned to many courses. 
//address column of Student Table is pointed to the Address Table with unique set to true.

course.Set("teacher", address); 

student.SaveAsync();
              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='Relationships-manyToMany' name="Relationships-manyToMany" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Many-to-Many Relationship</h3>
               <p>
                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>
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//Type #1 : Relation Option
var student = new CB.CloudObject("Student"); 
var course = new CB.CloudObject("Course"); 

//here one student be into many courses, and vice versa. 
var studentCourse = new CB.CloudObject("StudentCourse");
studentCourse.Set("student", student);
studentCourse.Set("teacher", teacher); 

await studentCourse.SaveAsync();


// ======================================================

//Type #2 : List Option.

var student = new CB.CloudObject("Student"); 

//create an array. 
var courseList = new ArrayList();

//a new course
var course = new CB.CloudObject("Course"); 

//add it to the list. You can push any number of objects you need. 
courseList.Add(course);


//here one student be into many courses, and vice versa. 
student.Set("courses", courseList); 

await student.SaveAsync();


              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

        </div>
<!-- CloudQuery Section -->

        <div class="method">
          <a id='CloudQuery' name="CloudQuery" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>CB.CloudQuery</h1>
              <p>
                It encapsulates a set of methods and attributes required to query your data in
                CloudApp to retrieve desired set of results.
              </p>

            </div>
            <div class="method-example" id="api-summary-example">
            </div> <!-- method-example -->
          </div><!-- method-section -->
          <a id='CloudQuery-constructor' name="CloudQuery-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">              
              <h3>Constructor</h3>
              <p>
              Instantiates a <code>CloudQuery</code> object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>tableName</dt>
                  <dd class="">string <span>The name of the table you want to query on.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">var query = new CB.CloudQuery("Student");</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='CloudQuery-equalTo' name="CloudQuery-equalTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.EqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> is equal to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Anything<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.EqualTo("age", 21); //find all Students who age is 21
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudQuery-containedIn' name="CloudQuery-containedIn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.ContainedIn( <code>columnName, data</code> )</h3>
              <p>
              If you want to retrieve objects matching several different values, you can use containedIn, providing an array of acceptable values. This is often useful to replace multiple queries with a single query. 
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be checked</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Array <span>The value(s) that are to be matched with.</span></dd>
                  <div class="clearfix"></div>

                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
//Get Student where name is equal to Smith, Max or Lucy
var list = new ArrayList();
list.Add("Smith");
list.Add("Max");
list.Add("Lucy");
query.ContainedIn("name", list);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-containsAll' name="CloudQuery-containsAll" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.ContainsAll( <code>columnName, data</code> )</h3>
              <p>
               Find objects where the array data in columnName contains all of the elements of data.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be checked</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Array <span>The value(s) that are to be matched with.</span></dd>
                  <div class="clearfix"></div>

                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
//find Students who are in JavaScript and C# class
var list = new ArrayList();
list.Add("java");
list.Add("javascript");
query.ContainsAll("classes", list);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-startsWith' name="CloudQuery-startsWith" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.StartsWith( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant to find the data in which value of <code>columnName</code>
              of each data is starts with <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be checked</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string <span>The value that is to be checked with.</span></dd>
                  <div class="clearfix"></div>

                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
//find all the Students who name starts with letter 'S'
query.StartsWith("name", "S");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-notEqualTo' name="CloudQuery-notEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.NotEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> does not has the value <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Anything<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
//find all Students info except of Smith
query.NotEqualTo("name", "Smith");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-notContainedIn' name="CloudQuery-notContainedIn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.NotContainedIn( <code>columnName, data</code> )</h3>
              <p>
               If you want to retrieve objects which doesnot include several different values, you can use notContainedIn, providing an array of acceptable values. This is often useful to replace multiple queries with a single query. 
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The name of the column whose value is to be checked</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Array <span>The value(s) that are to be matched with.</span></dd>
                  <div class="clearfix"></div>

                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

var query = new CB.CloudQuery("Student");
//Get all Students except Smith, Max and Lucy
var list = new ArrayList();
list.Add("Smith");
list.Add("Max");
list.Add("Lucy");
query.NotContainedIn("name", list);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-greaterThan' name="CloudQuery-greaterThan" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.GreaterThan( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value greater than <code>data</code>.
              </p>
              <div class="method-list">
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string / number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions. </p>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

var query = new CB.CloudQuery("Teacher");
//find all the teachers who are old.
query.GreaterThan("age", 60);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-greaterThanEqualTo' name="CloudQuery-greaterThanEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.GreaterThanEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value greater than or equals to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string / number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Teacher");
query.GreaterThanEqualTo("age", 60);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-lessThan' name="CloudQuery-lessThan" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.LessThan( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value less than <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string/number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.LessThan("age", 18);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-lessThanEqualTo' name="CloudQuery-lessThanEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.LessThanEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value less than or equals to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string/number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.LessThanEqualTo("age", 17);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-or' name="CloudQuery-or" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.Or( <code>query1, query2</code> )</h3>
              <p>
              It adds a logical OR contriant between 2 <code>CloudQuery</code> objects for 
              finding the set of the data satisfying conditions of both <code>query1</code>
              and <code>query2</code>.
              </p>
              <p>
                Both of the <code>CloudQuery</code> objects should be of the same collection
                otherwise it throws an error.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>query1</dt>
                  <dd class=""><code>CloudQuery object</code></dd>
                  <div class="clearfix"></div>
                  <dt>query2</dt>
                  <dd class=""><code>CloudQuery object</code></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>CloudQuery</code> object which contains
                OR'ed query of both of the <code>CloudQuery</code> objects.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//find all Student such that 10&lt;age&lt;18

var query1 = new CloudQuery("Student");
query1.LessThan("age", 18);

var query2 = new CB.CloudQuery("Student"");
query2.GreaterThan("age", 10);

CloudQuery query = CloudQuery.Or(query1, query2);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
              
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-orderByAsc' name="CloudQuery-orderByAsc" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.OrderByAsc( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for arranging the subset of the data in ascending 
              order.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.OrderByAsc("age");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-orderByDesc' name="CloudQuery-orderByDesc" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.OrderByDesc( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for arranging the subset of the data in descending 
              order.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

               <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.OrderByDesc("age");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-setLimit' name="CloudQuery-setLimit" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.Limit</h3>
              <p>
              It adds a contriant to limit no. of the data to be
              fetched from the database.
              </p>
              <p>
                If it is not set explicitly, database returns 20 results by default.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.Limit = 5;
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-setSkip' name="CloudQuery-setSkip" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.Skip</h3>
              <p>
              It adds a constraint to skip <code>data</code> no. of data
              matching satisfying the query contraints and fetching
              from the database.
              </p>
              <p>
                It requires a <em>sort</em> contriant and if none of it is 
                provided by the user then the documents are sorted according 
                to the <i>createdAt</i> attribute associated with the data.
              </p>
             
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CloudQuery("Student");
query.Skip = 5;
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-selectColumn' name="CloudQuery-selectColumn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.SelectColumn( <code>columnNames</code> )</h3>
              <p>
              It adds a contriant limiting the columns that are to fetched
              for each of the data from the database.
              </p>
              <p>
                <i>id</i>, <i>createdAt</i>, <i>updatedAt</i> and <i>ACL</i>
                are always returned unless explicitly provided by the user to
                discard it using <a href="#CloudQuery-doNotSelectColumn">doNotSelectColumn()</a>
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnNames</dt>
                  <dd class="">string/Object/Array <span>The name of the column(s) that are to be returned</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudQuery query = new CloudQuery("Student");
var list = new ArrayList();
list.Add("name");
list.Add("age");                  
query.SelectColumn(list);
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-doNotSelectColumn' name="CloudQuery-doNotSelectColumn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.DoNotSelectColumn( <code>columnNames</code> )</h3>
              <p>
              It adds a contriant restricting the columns given in <code>columnNames</code> 
              to be fetched for each of the data from the database.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnNames</dt>
                  <dd class="">string/Object/Array <span>The name of the column(s) that are not to be returned</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudQuery query = new CloudQuery("Student");query.greaterThan("age", 18);
query.DoNotSelectColumn("address");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-exists' name="CloudQuery-exists" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h3>CloudQuery.Exists( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> exists irrespective of what its value is.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column name which is to be checked for existence</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.Exists("address");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-doesNotExists' name="CloudQuery-doesNotExists" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.DoesNotExists( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> does not exists.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column name which is to be checked for non-existence</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same query object, which can be helpful in chaining query functions.</p>
                
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var query = new CB.CloudQuery("Student");
query.DoesNotExists("address");
var response = (List&lt;CB.CloudObject&gt;) await query.FindAsync();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

                    <a id='CloudQuery-find' name="CloudQuery-find" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.FindAsync()</h3>
              <p>
                Queries the database on the constraints provided by the <code>CloudQuery</code>
                object and gets the result as an array of <code>CloudObject</code> objects.
              </p>
              <p>
              If no. of documents to be returned is not specified using <a href="#CloudQuery-setLimit">limit()</a>
              then at max 20 documents are returned in each query by default.
              </p>
              <p>
                If no. of documents to be skipped is specified using <a href="#CloudQuery-setSkip">skip()</a> 
                without sorting parameter then the documents matching the query provided in 
                <code>CloudQuery</code> object are sorted in ascending order of <i>createdAt</i> field.
              </p>
              <div class="method-list">
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns an array of <code>CloudObject</code> objects.</p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js java">

var list = (List&lt;CB.CloudObject&gt;) await query.FindAsync();
string name;
int age;
for(int i=0; i &lt; list.Count; i++ ){
	name = (string)list[i].Get("name");
	age = (int)list[i].Get("age");
}</span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-findOne' name="CloudQuery-findOne" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.FindOneAsync( )</h3>
              <p>
                Queries the database on the constraints provided by the <code>CloudQuery</code>
                object and gets a single <code>CloudObject</code> object satisfying the constraint.
              </p>
              <p>
                If no. of documents to be skipped is specified using <a href="#CloudQuery-setSkip">skip()</a> 
                without sorting parameter then the documents matching the query provided in 
                <code>CloudQuery</code> object are sorted in ascending order of <i>createdAt</i> field.
              </p>
              <div class="method-list">
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>CloudObject</code> object or an error object if the opertion is successful.It throws an error 
                too if sufficient data is not available to query the database.
               </p>
               <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
              
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js java">
string name;
int age;

var obj = (CB.CloudObject) await query.FindOneAsync();
name = (string)obj.get("name");
age = (int)obj.get("age");
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudQuery-get' name="CloudQuery-get" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.GetAsync( <code>id</code> )</h3>
              <p>
                Queries the database gets a <code>CloudObject</code> object whose <i>id</i> field
                matches <code>id</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>id</dt>
                  <dd class="">string <span>The ID of the data which is to be matched with <i>_id</i> field
                  in the database.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>CloudObject</code> object or an error object if the opertion is successful. It throws an error 
                too if sufficient data is not available to query the database.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
//retrieve a Student detail by his unique ID
var obj = (CB.CloudObject) await query.GetAsync("54e837d6d51a5ea011aa79ea");</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudQuery-count' name="CloudQuery-count" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.CountAsync( )</h3>
              <p>
              It adds a contriant to find the data in which value of <code>columnName</code>
              of each data is at least equal to all of the value(s) provided in <code>data</code>.
              </p>
              <div class="method-list">
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns an <i>Integer</i> which is the number of documents matching the
                constraints given in the <code>CloudQuery</code>.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">//fetch how many Students are there who age&gt;18
var count = await (int)query.CountAsync();</span></span></code>
            </div><!-- method-example -->

          </div> <!-- method-section -->
          <a id='CloudQuery-distinct' name="CloudQuery-distinct" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudQuery.DistinctAsync( <code>columnName</code> )</h3>
              <p>
              It returns distinct objects which have columnName
              </p>
              <p>
                Sort parameter is required and if not provided by the user ascending order
                sorting on <i>createdAt</i> field is applied by default.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">
                  
                  <dt>columnName</dt>
                  <dd class="">String <span> The column name which should have distinct values in the
                  returned data set.</span></dd>
                  <div class="clearfix"></div>                  
                </dl>

                <h6>Returns</h6>
                <p>It returns an array of <code>CloudObject</code> objects which are documents 
                matching the given query in the <code>CloudQuery</code> object having distinct values of
                <code>ColumnName</code>.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var list = (List&lt;CB.CloudObject&gt;) await query.DistinctAsync("address");</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
        </div><!-- method -->
        
        <!--Inlcude-->
          <a id='CloudQuery-include' name="CloudQuery-include" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudQuery.Include( <code>columnName</code> )</h3>
                  <p>
                      It gives the join on columnName for the table being queried upon.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>columnName</dt>
                          <dd class="">String <span> The column name on which join is to be performed.</span></dd>
                          <div class="clearfix"></div>

                      </dl>

                      <h6>Returns</h6>
                      <p>Same query object, which can be helpful in chaining query functions.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">//joins table student with hostel
var query = new CB.CloudQuery("Student");
query.Include("hostel");
</span></span></code>
              </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='CloudQuery-near' name="CloudQuery-near" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudQuery.Near(columnName,geoPoint, range)</h3>
                  <p>
                      Queries for <code>CloudObject</code> objects which are within range.It gives result in the order of nearest to farthest.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>ColumnName</dt>
                          <dd class="">String <span> Name of column which has the <code>CloudGeoPoint</code></span></dd>
                          <div class="clearfix"></div>
                          <dt>CloudGeoPoint</dt>
                          <dd class="">Object <span> It is the point close to which the points are to be found
                   respective response.</span></dd>
                          <div class="clearfix"></div>
                          <dt>Range</dt>
                          <dd class="">Number <span> It the range within which are CloudObjects are to be sought. It is given in Meters</span></dd>
                          <div class="clearfix"></div>

                      </dl>

                      <h6>Returns</h6>
                      <p>Same query object, which can be helpful in chaining query functions.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var loc = new CB.CloudGeoPoint(17.7,80.3);
var query = new CB.CloudQuery("Custom5"");
query.Near("location", loc, 100000);
var response = await query.Find();

</span></span></span></code>

              </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudQuery-geowithin' name="CloudQuery-geowithin" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudQuery.Geowithin("ColumnName",CloudGeoPoint,Radius)</h3>
                  <p>
                      Queries for CloudObject objects which are within range.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>ColumnName</dt>
                          <dd class="">Object <span> Name of column which has the <code>CloudGeoPoint</code></span></dd>
                          <div class="clearfix"></div>
                          <dt>CloudGeoPoints</dt>
                          <dd class="">Array <span> Array of CloudGeopoints within which we want to search CloudObjects or Center of Circle in case the shape is circle</span></dd>
                          <div class="clearfix"></div>
                          <dt>Radius</dt>
                          <dd class="">decimal <span> [Optional] Radius of Circle. Radius is taken in Meters</span></dd>
                          <div class="clearfix"></div>
                      </dl>

                      <h6>Returns</h6>
                      <p>Same query object, which can be helpful in chaining query functions.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var loc1 = new CB.CloudGeoPoint(18.4,78.9);
var loc2 = new CB.CloudGeoPoint(17.4,78.4);
var loc3 = new CB.CloudGeoPoint(17.7,80.4);
var query = new CB.CloudQuery("Custom");
var list = new ArrayList();
list.Add(loc1);
list.Add(loc2);
list.Add(loc3);
query.GeoWithin("location", list);
var response = await query.Find();

</span></span></span></code>

              </div><!-- method-example -->
          </div> <!-- method-section -->
<!-- CloudNotifications  --> 

        <div class="method">
             <a id='CloudNotifcations' name="CloudNotifcations" class="section-anchor">&nbsp;</a>
            <div class="method-section">
              <div class="method-description">

                <h1>CloudNotifcations</h1>
                <p>

                In Cloudboost, you can create realtime notification channels, publish messages to those channels and have other clients listen to those messages which are being published in real time. 
                </p>

              </div>
            </div>

                      <a id='CloudNotification-on' name="CloudNotification-on" class="section-anchor">&nbsp;</a>
        
          <div class="method-section">
            <div class="method-description">

              <h3>CloudNotification.On( <code>channelName, Callback</code> )</h3>
              <p>
              Listens to notification channels.
              </p>
                          
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>channelName</dt>
                  <dd class="">String<span>channel to listen to.</span></dd>
                  <div class="clearfix"></div>
                  <dt>Callback</dt>
                  <dd class="">function <span> function to fire when data on this channel is published.</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>void</p>
                <h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
CB.CloudNotification.On("sample", new Callback(action));
void action(Object result)
{
    //function to fire
}


              </span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='CloudNotification-publish' name="CloudNotification-publish" class="section-anchor">&nbsp;</a>
        
          <div class="method-section">
            <div class="method-description">

              <h3>CloudNotification.publish( <code>channelName, data</code> )</h3>
              <p>
              Publishes data to notification channels.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>channelName</dt>
                  <dd class="">String<span>channel to publish to.</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Anything <span> data you want to publish to this channel</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>void</p>
    
                <h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
CB.CloudNotification.Publsh("sample", "data");


              </span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudNotification-off' name="CloudNotification-off" class="section-anchor">&nbsp;</a>
        
          <div class="method-section">
            <div class="method-description">

              <h3>CloudNotification.Off( <code>channelName</code> )</h3>
              <p>
              Stops listening to notification channels.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>channelName</dt>
                  <dd class="">String<span>channel to stop listening to.</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>void</p>
                <h6>Error Handling</h6>
                <p>It throws <code>CB.Exception.CloudBoostException</code></p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
CB.CloudNotification.Off("sample");

              </span></span></code>

            </div><!-- method-example -->
          </div> <!-- method-section -->

        </div>
<!-- CloudSearch -->

        <div class="method">
          <a id='CloudSearch' name="CloudSearch" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h1>CloudSearch</h1>
              <p>
                It encapsulates a set of methods and attributes required to perform search on your data in CloudApp to retrieve desired set of relevant results.
              </p>

            </div>
            <div class="method-example" id="api-summary-example">
            </div> <!-- method-example -->
          </div><!-- method-section -->
          <a id='CloudSearch-constructor' name="CloudSearch-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Constructor</h3>
              <p>
              CB.CloudSearch(<code>tableName</code>)
              </p>
              <div class="method-list">
              
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>tableNames</dt>
                  <dd class="">Array/string <span>The name of the table(s) you want to search on.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudSearch cs = new CloudSearch("Student");</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

           <a id='sq-searchOn' name="CloudSearch-searchOn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.SearchOn( <code>columnName, query</code> )</h3>
              <p>
              Used to perform a search query.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string / Array <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">query<span>A text query</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

var list = new ArrayList();
list.Add("C++");
list.Add("Java");
list.Add("C#");
var cs = new CB.CloudSearch("Student");
cs.SearchOn("resume", list);


var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
<a id='sq-phrase' name="sq-searchOn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.phrase( <code>columns, queryText, [fuzziness], [priority]</code> )</h3>
              <p>
              Used to find the Phrase in search. For example, If you want to match a search text "Brown Fox" in your records <b>as is</b>, then you use Phrase Query. 
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string / Array <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>queryText</dt>
                  <dd class="">string<span>A text query</span></dd>
                  <div class="clearfix"></div>

                  <dt>fuzziness</dt>
                  <dd class="">[Optional] integer<span>Can be set to 0, 1, 2. Default is 0. This parameter sets the fuzziness on search.</span></dd>
                  <div class="clearfix"></div>

                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.Phrase("resume", "Java");
List&lt;CB.CloudObject&gt; response = await CS.Search();;
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


        <a id='sq-bestColumns' name="sq-bestColumns" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.BestColumns( <code>columns, queryText, [fuzziness], [all_words], [match_percent], [priority]</code> )</h3>
              <p>
              This function is most useful when you are searching for multiple words best found in the same field. For instance “brown fox” in a single field is more meaningful than “brown” in one field and “fox” in the other.

              For example : If you have two records, 
              <table>
                <th>
                  <tr>
                    ID
                  </tr>
                  <tr>
                    Sample 1
                  </tr>
                  <tr>
                   Sample 2
                  </tr>
                  
                </th>
                <td>
                  <tr>
                    1
                  </tr>
                  <tr>
                    Brown Fox
                  </tr>
                  <tr>
                    Up the hill
                  </tr>
                </td>
                <td>
                  <tr>
                    2
                  </tr>
                  <tr>
                    Brown 
                  </tr>
                  <tr>
                   Fox up the hill
                  </tr>
                </td>
              </table>

              In this case, If you search for brown fox then Record with ID 1 will be more relevant than record with ID 2

              </p>


              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnNames</dt>
                  <dd class=""> Array <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>

                  <dt>queryText</dt>
                  <dd class="">string<span>A text query</span></dd>
                  <div class="clearfix"></div>

                  <dt>fuzziness</dt>
                  <dd class="">[Optional] integer<span>Can be set to 0, 1, 2. Default is 0. This parameter sets the fuzziness on search.</span></dd>
                  <div class="clearfix"></div>

                  <dt>all_words</dt>
                  <dd class="">[Optional] string<span>Can take only value - true. If set the search will contain all the words in query. For example, If your search query is "Brown Fox". Results will contain both the words "Brown" AND "Fox".</span></dd>
                  <div class="clearfix"></div>

                  <dt>match_percent</dt>
                  <dd class=""> [Optional] string<span>Can take only value - %. For ex : "75%". If set the search will return all the results which matches 75%.</span></dd>
                  <div class="clearfix"></div>

                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch('Student');
cs.searchQuery = new CB.SearchQuery();
var list = new ArrayList();
list.Add("Sample1");
list.Add("Sample2");
cs.searchQuery.BestColumns(list, "Brown Fox", null, null, null, null);
List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


        <a id='sq-mostColumns' name="sq-mostCOlumns" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.MostColumns( <code>columns, queryText, [fuzziness], [all_words], [match_percent], [priority]</code> )</h3>
              <p>

              This fucntion is most useful when querying multiple fields that contain the same text should be given higher relevance than others. 

              For example : If you have two records, 
              <table>
                <th>
                  <tr>
                    ID
                  </tr>
                  <tr>
                    Sample 1
                  </tr>
                  <tr>
                   Sample 2
                  </tr>
                  
                </th>
                <td>
                  <tr>
                    1
                  </tr>
                  <tr>
                    Brown
                  </tr>
                  <tr>
                    Up the hill
                  </tr>
                </td>
                <td>
                  <tr>
                    2
                  </tr>
                  <tr>
                   Brown 
                  </tr>
                  <tr>
                   Fox up the hill
                  </tr>
                </td>
              </table>

              In this case, If you search for brown fox then Record with ID 2 will be more relevant than record with ID 1

              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnNames</dt>
                  <dd class=""> Array <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>

                  <dt>queryText</dt>
                  <dd class="">string<span>A text query</span></dd>
                  <div class="clearfix"></div>

                  <dt>fuzziness</dt>
                  <dd class="">[Optional] integer<span>Can be set to 0, 1, 2. Default is 0. This parameter sets the fuzziness on search.</span></dd>
                  <div class="clearfix"></div>

                  <dt>all_words</dt>
                  <dd class="">[Optional] string<span>Can take only value - true. If set the search will contain all the words in query. For example, If your search query is "Brown Fox". Results will contain both the words "Brown" AND "Fox".</span></dd>
                  <div class="clearfix"></div>

                  <dt>match_percent</dt>
                  <dd class=""> [Optional] string<span>Can take only value - %. For ex : "75%". If set the search will return all the results which matches 75%.</span></dd>
                  <div class="clearfix"></div>

                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.searchQuery = new CB.SearchQuery();
var list = new ArrayList();
list.Add("Sample1");
list.Add("Sample2");
cs.searchQuery.MostColumns(list, "Brown Fox", null, null, null, null);
List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


        <a id='sq-startsWith' name="sq-startsWith" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.StartsWith( <code>column, value, [priority]</code> )</h3>
              <p>

              Starts with query.
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class=""> String <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>

                  <dt>value</dt>
                  <dd class="">string<span>A text query</span></dd>
                  <div class="clearfix"></div>


                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.StartsWith("Sample1", "Brown");
List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='sq-wildcard' name="sq-wildcard" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.WildCard( <code>column, value, [priority]</code> )</h3>
              <p>

              Wildcard Query.
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class=""> String <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>

                  <dt>value</dt>
                  <dd class="">string<span>A wildcard value</span></dd>
                  <div class="clearfix"></div>


                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student"");
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.WildCard("Sample1", "B*");

List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='sq-regexp' name="sq-regexp" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.RegExp( <code>column, value, [priority]</code> )</h3>
              <p>

              A Regular Expression Query
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class=""> String <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>

                  <dt>value</dt>
                  <dd class="">string<span>A text query</span></dd>
                  <div class="clearfix"></div>


                  <dt>priority</dt>
                  <dd class="">[Optional] integer<span>If set this query will have a higer priority over all other queries.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.RegExp("Sample", "B[a-z]*");

List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='sq-or' name="sq-or" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.Or( <code>searchQuery</code> )</h3>
              <p>

              OR a SearchQuery
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>searchQuery</dt>
                  <dd class=""> CB.SearchQuery <span>SearchQuery object to be OR'ed</span></dd>
                  <div class="clearfix"></div>

                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student"");
cs.searchQuery = new CB.SearchQuery();

var obj1 = new CB.SearchQuery();
obj1.SearchOn("name", "Dan", null, null, null, null);

var obj2 = new CB.SearchQuery();
obj2.SearchOn("name", "Sam", null, null, null, null);

cs.searchQuery.Or(obj1);
cs.searchQuery.Or(obj2);

List&lt;CB.CloudObject&gt; response = await CS.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='sq-and' name="sq-and" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.And( <code>searchQuery</code> )</h3>
              <p>

              AND a SearchQuery
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>searchQuery</dt>
                  <dd class=""> CB.SearchQuery <span>SearchQuery object to be AND'ed</span></dd>
                  <div class="clearfix"></div>

                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student"");
cs.searchQuery = new CB.SearchQuery();

var obj1 = new CB.SearchQuery();
obj1.SearchOn("name", "Dan", null, null, null, null);

var obj2 = new CB.SearchQuery();
obj2.SearchOn("name", "Sam", null, null, null, null);

cs.searchQuery.And(obj1);
cs.searchQuery.And(obj2);

List&lt;CB.CloudObject&gt; response = await CS.Search();

</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='sq-not' name="sq-not" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>SearchQuery.Not( <code>searchQuery</code> )</h3>
              <p>

              NOT a SearchQuery
              </p>

              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>searchQuery</dt>
                  <dd class=""> CB.SearchQuery <span>SearchQuery object to be NOT</span></dd>
                  <div class="clearfix"></div>

                  
                </dl>

                <h6>Returns</h6>
                <p>Same SearchQuery object, which can be helpful in chaining search functions.</p>
              </div>
            </div>


            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student"");
cs.searchQuery = new CB.SearchQuery();

var obj1 = new CB.SearchQuery();
obj1.SearchOn("name", "Dan", null, null, null, null);

var obj2 = new CB.SearchQuery();
obj2.SearchOn("name", "Sam", null, null, null, null);

cs.searchQuery.Not(obj1);
cs.searchQuery.Not(obj2);

List&lt;CB.CloudObject&gt; response = await CS.Search();


</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='SearchFilter-equalTo' name="CloudSearch-equalTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.EqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> is equal to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Anything<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.EqualTo("age", 21); //find all Students who age is 21

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

         
          <a id='SearchFilter-notEqualTo' name="CloudSearch-notEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.NotEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> does not has the value <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">Anything<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining query functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
//find all Students info except of Smith
cs.NotEqualTo("name", "Smith");

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          
          <a id='SearchFilter-greaterThan' name="CloudSearch-greaterThan" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.GreaterThan( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value greater than <code>data</code>.
              </p>
              <div class="method-list">
                <h6>Arguments</h6>
                <dl class="argument-list">
                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string / number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions. </p>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

var cs = new CloudSearch("Teacher");
//find all the teachers who are old.
cs.GreaterThan("age", 60);

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='SearchFilter-greaterThanEqualTo' name="CloudSearch-greaterThanEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.GreaterThanEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value greater than or equals to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string / number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Teacher");
cs.GreaterThanEqualTo("age", 60);

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='SearchFilter-lessThan' name="CloudSearch-lessThan" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.LessThan( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value less than <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string/number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.LessThan("age", 18);

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='SearchFilter-lessThanEqualTo' name="CloudSearch-lessThanEqualTo" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.LessThanEqualTo( <code>columnName, data</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> has the value less than or equals to <code>data</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  <dt>data</dt>
                  <dd class="">string/number<span>The value of the equals contraint</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.LessThanEqualTo("age", 17);

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();

</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='sq-or' name="CloudSearch-or" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.Or( <code>cloudSearch1, cloudSearch2</code> )</h3>
              <p>
              It adds a logical OR contriant between 2 <code>CloudSearch</code> objects for 
              finding the set of the data satisfying conditions of both <code>cloudSearch1</code>
              and <code>cloudSearch2</code>.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>cloudSearch1</dt>
                  <dd class=""><code>CloudSearch object</code></dd>
                  <div class="clearfix"></div>
                  <dt>cloudSearch2</dt>
                  <dd class=""><code>CloudSearch object</code></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>CloudSearch</code> object which contains
                OR'ed query of both of the <code>CloudSearch</code> objects.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//find all Student such that 10&lt;age&lt;18

var cs1 = new CloudSearch("Student");
cs1.LessThan("age", 18);
cs1.SearchOn("name", "Sam");

var cs2 = new CloudSearch("Student");
cs2.GreaterThan("age", 10);
cs1.SearchOn("name", "Dan");

var cs = CloudSearch.or(cs1, cs2);

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
              
            </div><!-- method-example -->
          </div> <!-- method-section -->
          
          <a id='SearchFilter-or' name="SearchFilter-or" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h3>SearchFilter.Or( <code>searchFilter )</h3>
              <p>
              It adds a logical OR contriant to <code>SearchFilter</code> object for 
              finding the set of the data satisfying conditions of <code>SearchFilter</code>
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>SearchFilter</dt>
                  <dd class=""><code>SearchFilter Object</code></dd>
                  <div class="clearfix"></div>
                  
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>SearchFilter</code> object which contains
                OR'ed query of <code>SearchFilter</code> object.</p>
              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//find all Student such that 10&lt;age&lt;18

//create first searchFilter. 
var searchFilter1 = new CB.SearchFilter();
searchFilter1.LessThan("age", 10);

//create second search Filter. 
var searchFilter2 = new CB.SearchFilter();
searchFilter2.GreaterThan("age", 18);

//and both of these. 
var searchFilter = new CB.SearchFilter();
searchFilter.Or(searchFilter1);
searchFilter.Or(searchFilter2);

//attach NOT'ed searchFilter to CloudSearch. 
var cs = new CB.CloudSearch("Student"");
cs.searchFilter = searchFilter;
//search term
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.SearchOn("name","Dan");

List&lt;CB.CloudObject&gt; list = await cs.Search();
</span></span></code>
              
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='SearchFilter-and' name="SearchFilter-and" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h3>SearchFilter.And( <code>searchFilter )</h3>
              <p>
              It adds a logical AND contriant to <code>SearchFilter</code> object for 
              finding the set of the data satisfying conditions of <code>SearchFilter</code>
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>SearchFilter</dt>
                  <dd class=""><code>SearchFilter Object</code></dd>
                  <div class="clearfix"></div>
                  
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>SearchFilter</code> object which contains
                OR'ed query of <code>SearchFilter</code> object.</p>
              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//find all students of age less than 10 AND greater than 18.

//create first searchFilter. 
var searchFilter1 = new CB.SearchFilter();
searchFilter1.LessThan("age", 10);

//create second search Filter. 
var searchFilter2 = new CB.SearchFilter();
searchFilter2.GreaterThan("age", 18);

//and both of these. 
var searchFilter = new CB.SearchFilter();
searchFilter.And(searchFilter1);
searchFilter.And(searchFilter2);

//attach NOT'ed searchFilter to CloudSearch. 
var cs = new CB.CloudSearch("Student"");
cs.searchFilter = searchFilter;
//search term
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.SearchOn("name","Dan");

List&lt;CB.CloudObject&gt; list = await cs.Search();
</span></span></code>
              
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='SearchFilter-not' name="SearchFilter-not" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h3>SearchFilter.Not( <code>searchFilter )</h3>
              <p>
              It adds a logical NOT contriant to <code>SearchFilter</code> object for 
              finding the set of the data satisfying conditions of <code>SearchFilter</code>
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>SearchFilter</dt>
                  <dd class=""><code>SearchFilter Object</code></dd>
                  <div class="clearfix"></div>
                  
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns a <code>SearchFilter</code> object which contains
                OR'ed query of <code>SearchFilter</code> object.</p>
              </div>

            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//find all students of age less than 10 AND greater than 18.

//create first searchFilter. 
var searchFilter1 = new CB.SearchFilter();
searchFilter1.LessThan("age", 10);

//create second search Filter. 
var searchFilter2 = new CB.SearchFilter();
searchFilter2.GreaterThan("age", 18);

//and both of these. 
var searchFilter = new CB.SearchFilter();
searchFilter.Not(searchFilter1);
searchFilter.Not(searchFilter2);

//attach NOT'ed searchFilter to CloudSearch. 
var cs = new CB.CloudSearch("Student"");
cs.searchFilter = searchFilter;
//search term
cs.searchQuery = new CB.SearchQuery();
cs.searchQuery.SearchOn("name","Dan");

List&lt;CB.CloudObject&gt; list = await cs.Search();
</span></span></code>
              
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudSearch-orderByAsc' name="CloudSearch-orderByAsc" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.OrderByAsc( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for arranging the subset of the data in ascending 
              order.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.OrderByAsc("age");

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudSearch-orderByDesc' name="CloudSearch-orderByDesc" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.OrderByDesc( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for arranging the subset of the data in descending 
              order.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The attribute on which the contraint is to be applied</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

               <h6>Returns</h6>
                <p>Same search object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CloudSearch("Student");
cs.OrderByDesc('age');

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudSearch-setLimit' name="CloudSearch-setLimit" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.Limit</h3>
              <p>
              It adds a contriant to limit no. of the data to be
              fetched from the database.
              </p>
              <p>
                If it is not set explicitly, database returns 20 results by default.
              </p>
              <div class="method-list">
                
               
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.Limit = 5;

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudSearch-setSkip' name="CloudSearch-setSkip" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.Skip</h3>
              <p>
              It adds a constraint to skip <code>data</code> no. of data
              matching satisfying the query contraints and fetching
              from the database.
              </p>
              <div class="method-list">
                
                
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.Skip = 5;

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          

          <a id='SearchFilter-exists' name="CloudSearch-exists" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h3>CloudSearch.Exists( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> exists irrespective of what its value is.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column name which is to be checked for existence</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.Exists("address");

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='SearchFilter-doesNotExists' name="CloudSearch-doesNotExists" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.DoesNotExists( <code>columnName</code> )</h3>
              <p>
              It adds a contriant for finding the subset of the data in which 
              <code>columnName</code> does not exists.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>columnName</dt>
                  <dd class="">string <span>The column name which is to be checked for non-existence</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>Same CloudSearch object, which can be helpful in chaining search functions.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var cs = new CB.CloudSearch("Student");
cs.DoesNotExists("address");

var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudSearch-search' name="CloudSearch-search" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudSearch.Search( )</h3>
              <p>
                Searches the database on the constraints provided by the <code>CloudSearch</code>
                object and gets the result as an array of <code>CloudObject</code> objects.
              </p>
              <p>
              If no. of documents to be returned is not specified using <a href="#CloudQuery-setLimit">limit()</a>
              then at max 20 documents are returned in each query by default.
              </p>
              <div class="method-list">
         
                <h6>Returns</h6>
                <p>It returns an array of <code>CloudObject</code> objects.</p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">


var searchResultList = (List&lt;CB.CloudObject&gt;)await cs.Search();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
      </div>
<a id='CloudGeoPoint' name="CloudGeoPoint" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">
                  <h1>CB.CloudGeoPoint</h1>
                  <p>
                      <code>CloudGeoPoint</code> is used to store GeoPoints and perform GeoPoint operation like finding points near and bounding box.
                  </p>
                  <p>
                      A <code>CloudGeoPoint</code> object has to be saved in <code>CloudObject</code> in a column.
                  </p>
                  <p>
                      All the modifications in the GeoPoint can be reflected only after the object is saved after the changes.
                  </p>
              </div>
          </div>

          <a id='CloudGeoPoint-constructor' name="CloudGeoPoint-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>Constructor</h3>
                  <p>
                      Init's a <code>CloudGeoPoint</code> object.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <p>It takes latitude and longitude of a GeoPoint. Points are double data type.</p>

                      <h6>Returns</h6>
                      <p>It returns a <code>CloudGeoPoint</code> object.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var point = new CB.CloudGeoPoint(17.4,78.5);

</span></span></code>
              </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudGeoPoint-dkm' name="CloudGeoPoint-dkm" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudGeoPoint.DistanceInKms(CloudGeoPoint)</h3>
                  <p>
                      Finds distance between CloudGeoPoints in kilometers.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>CloudGeoPoint</dt>
                          <dd class="">Object <span> It is the point from which the distance to be found.</span></dd>
                          <div class="clearfix"></div>
                      </dl>

                      <h6>Returns</h6>
                      <p>Distance in Kilometers.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var loc = new CB.CloudGeoPoint(17.7,80.3);
var loc2 = new CB.CloudGeoPoint(10.7,70.3);
var distance = loc.DistanceInKMs(loc2);

</span></span></span></code>

              </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudGeoPoint-miles' name="CloudGeoPoint-miles" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudGeoPoint.DistanceInMiles(CloudGeoPoint)</h3>
                  <p>
                      Finds distance between CloudGeoPoints in Miles.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>CloudGeoPoint</dt>
                          <dd class="">Object <span> It is the point from which the distance to be found.</span></dd>
                          <div class="clearfix"></div>
                      </dl>

                      <h6>Returns</h6>
                      <p>Distance in Miles.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var loc = new CB.CloudGeoPoint(17.7,80.3);
var loc2 = new CB.CloudGeoPoint(10.7,70.3);
var distance = loc.DistanceInMiles(loc2);

</span></span></span></code>

              </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudGeoPoint-radians' name="CloudGeoPoint-radians" class="section-anchor">&nbsp;</a>
          <div class="method-section">
              <div class="method-description">

                  <h3>CloudGeoPoint.DistanceInRadians(CloudGeoPoint)</h3>
                  <p>
                      Finds distance between CloudGeoPoints in kilometers.
                  </p>
                  <div class="method-list">

                      <h6>Argument</h6>
                      <dl class="argument-list">

                          <dt>CloudGeoPoint</dt>
                          <dd class="">Object <span> It is the point from which the distance to be found.</span></dd>
                          <div class="clearfix"></div>
                      </dl>

                      <h6>Returns</h6>
                      <p>Distance in Radians.</p>
                  </div>
              </div>
              <div class="method-example" id="api-summary-example">
                  <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var loc = new CB.CloudGeoPoint(17.7,80.3);
var loc2 = new CB.CloudGeoPoint(10.7,70.3);
var distance = loc.DistanceInRadians(loc2);

</span></span></span></code>

              </div><!-- method-example -->
          </div> <!-- method-section -->
<a id='CloudUser' name="CloudUser" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h1>CloudUser</h1>
              <p>
                There is a notion of user accounts that lets users access their information in a secure manner.
                We provide a specialized user class called <code>CloudUser</code> that automatically handles
                much of the functionality required for user account management.
              </p>
              <p>
                <code>CloudUser</code> is a subclass of <code>CloudObject</code>, and has all the same features, such as flexible 
                schema, automatic persistence, and a key value interface. All the methods that are on 
                <code>CloudObject</code> also exist in <code>CloudUser</code>. The difference is that <code>CloudUser</code> has some special 
                additions specific to user accounts. With this class, you'll be able to add user account 
                functionality in your app.
              </p>
              <p>
                There is a special object <code>CloudUser.current</code> which holds the
                information of the current user logged in.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
          <a id='CloudUser-constructor' name="CloudUser-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Constructor</h3>
              <p>
              Instantiates a <code>CloudUser</code> object.
              </p>
              <div class="method-list">
              
                <h6>Argument</h6>
                <p>It takes no argument.</p>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudUser obj = new CloudUser();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudUser-signUp' name="CloudUser-signUp" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.SignUp( )</h3>
              <p>
                It registers new user given its <i>username</i>, <i>email</i> and <i>password</i>.
                Registration is successful if the given <i>email</i> is not already registered to an existing user.
              </p>
              <p>
                It sets the attributes of <code>CloudUser.current</code> object with the 
                <code>CloudUser</code> object recieved.
              </p>
              <div class="method-list">
                
                
                <h6>Returns</h6>
                <p>
                It returns a <code>CloudUser</code> object which has the user information if registration is successful.
                </p>
                <h6>Error Handling</h6>
                It throws <code>CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudUser user = new CloudUser();
user.Set("username", "my_username");
user.Set("password", "my_solid_password");
user.Set("email", "email@sample.com");
await user.SignUp();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudUser-logIn' name="CloudUser-logIn" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.LogIn( )</h3>
              <p>
                It logs in user given its <i>username</i> and <i>password</i>.
                Login is successful if the given <i>username</i> and <i>password</i> pair is already present in the database.
              </p>
              <p>
                It sets the attributes of <code>CloudUser.current</code> object with the 
                <code>CloudUser</code> object recieved.
              </p>
              <div class="method-list">
                
               </dl>


                <h6>Returns</h6>
                <p>
                It returns a <code>CloudUser</code> object which has the user information if registration is 
                successful.</p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var user = new CB.CloudUser();
user.Set("username", "my_username");
user.Set("password", "my_solid_password");
user.LogIn();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudUser-logOut' name="CloudUser-logOut" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.LogOut( )</h3>
              <p>
                It logs the user out.
              </p>
              <p>
                It sets the <code>CloudUser.Current</code> object to <i>null</i>.
              </p>
              <div class="method-list">
                
                <h6>Returns</h6>
                <p>
                It returns a <code>CloudUser</code> object having the user information of the user who was logged in. 
                </p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
CloudUser.Current.LogOut();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudUser-current' name="CloudUser-current" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.Current</h3>
              <p>
                Get the current logged in user.
              </p>
             
              
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
//gets the current user if user is loggedIn, null otherwise.
var currentUser = CloudUser.Current;</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
 <a id='CloudUser-addToRole' name="CloudUser-addToRole" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.AddToRole( <code>role</code> )</h3>
              <p>
                A user can be a part of many roles, like in real world. For this functionality
                user should get added to a Role.
              </p>
              <p>
                For this purpose <code>AddToRole()</code> of <code>CloudUser</code> comes in handy.
              </p>
              <div class="method-list">
                
                <h6>Arguments</h6>
                <dl class="argument-list">

                  <dt>role</dt>
                  <dd class="">CloudRole Object <span> The <code>CloudRole</code> object of the role you want to
                  add the user to.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>
                It returns a <code>CloudUser</code> object having the user information of the user who was logged in. 
                </p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostExceptionn</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">

//role is an instance of CloudRole Object.

CloudUser.Current.AddToRole(role);

</span></span></code>
            <p>Given <a href="#CloudRole-getRole">GetRole()</a> is discussed later</p>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudUser-isInRole' name="CloudUser-isInRole" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.IsInRole( <code>role</code> )</h3>
              <p>
                To check if the current user is in the role provided by the role object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>role</dt>
                  <dd class="">CloudRole Object <span> The <code>CloudRole</code> object of the role you want to
                  check the user to.</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>
                It returns a <i>true/false</i> based on whether the user is in the given
                role or not respectively.
                </p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
//role is the instance of the CloudRole object. 

if(CloudUser.Current.IsInRole(role)) {
  //The current user is in the given role.
} else {
  //The user is not in the given role.
}

}</span></span></code>
            <p>Given <a href="#CloudRole-getRole">GetRole()</a> is discussed later</p>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudUser-removeFromRole' name="CloudUser-removeFromRole" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudUser.RemoveFromRole( <code>role</code> )</h3>
              <p>
                Removes the user from the given role provided in <code>role</code> object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>role</dt>
                  <dd class="">CloudRole Object <span> The <code>CloudRole</code> object of the role you want to
                  remove the user from.</span></dd>
                  <div class="clearfix"></div>
                  </dl>

                <h6>Returns</h6>
                <p>
                It returns a <code>CloudUser</code> object having the user information of the user who was logged in.
                </p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
CloudUser.Current.RemoveFromRole(role);</span></span></code>
            <p>Given <a href="#CloudRole-getRole">GetRole()</a> is discussed later</p>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='CloudRole' name="CloudRole" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h1>CloudRole</h1>
              <p>
                As your app grows in scope and user-base, you may find yourself needing more 
                coarse-grained control over access to pieces of your data than user-linked ACLs
                can provide. To address this requirement, CloudBoost supports a form of Role-based 
                Access Control. Roles provide a logical way of grouping users with common access 
                privileges to your CB data. Roles are named objects that contain users and other 
                roles. Any permission granted to a role is implicitly granted to its users as 
                well as to the users of any roles that it contains.
              </p>
              <p>
                We provide a specialized class called <code>CloudRole</code> that represents these role 
                objects in your client code. <code>CloudRole</code> is a subclass of <code>CloudObject</code>, 
                and has all of the same features, such as a flexible schema, automatic 
                persistence, and a key value interface. All the methods that are on <code>CloudObject</code>
                also exist on <code>CloudRole</code>. The difference is that CB.CloudRole has some additions 
                specific to management of roles.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
          <a id='CloudRole-constructor' name="CloudRole-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Constructor</h3>
              <p>
              Instantiates a <code>CloudRole</code> object.
              </p>
              <div class="method-list">             	
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>roleName</dt>
                  <dd class="">string <span>The name of the role you want to deal with</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">CloudRole role = new CB.CloudRole("Student");</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudRole-getRole' name="CloudRole-getRole" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudRole.GetRole( <code>role</code> )</h3>
              <p>
              Gets a <code>CloudRole</code> object for a given <code>role</code> object with <i>name</i>
              field only.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>role</dt>
                  <dd class="">CloudRole object <span>The name of the role you want to deal with</span></dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                It returns a <code>CloudRole</code> object having the role information of the role whose name was 
                provided in the object of <code>role</code> argument.
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var role = new CB.CloudRole("my-collaborator");

CloudRole.GetRole(role);
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='CloudFile' name="CloudFile" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h1>CloudFile</h1>
              <p>
                <code>CloudFile</code> lets you store application files in the cloud that would otherwise be too large or 
                cumbersome to fit into a regular <code>CloudObject</code>. The most common use case is storing images, 
                but you can also use it for documents, videos, music, and any other binary data.
              </p>
            </div>
            <div class="method-example" id="api-summary-example">
            </div>
          </div>
          <a id='CloudFile-constructor' name="CloudFile-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Constructor</h3>
              <p>
              Instantiates a <code>CloudFile</code> object.
              </p>
              <div class="method-list">             	
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>file</dt>
                  <dd class="">byte[] object<span>The file/BLOB that you want to save</span></dd>
                  <div class="clearfix"></div>
                  <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
                </dl>

              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
byte[] data = System.Text.Encoding.UTF8.GetBytes(".net cloudfile testing!");
string name = "sample.txt";
string type = "txt";
var file = new CB.CloudFile(data, name, type);
var rsponse = file.SaveAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudFile-save' name="CloudRole-save" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudFile.SaveAsync( )</h3>
              <p>
              Saves the <code>CloudFile</code> object.
              </p>
              <div class="method-list">

                <h6>Returns</h6>
                <p>It returns a <code>CloudFile</code> object having <code>url</code> attribute set to the URL 
                of the blob uploaded to the server if the operation is successful.<p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
byte[] data = System.Text.Encoding.UTF8.GetBytes(".net cloudfile testing!");
string name = "sample.txt";
string type = "txt";
var file = new CB.CloudFile(data, name, type);
var rsponse = file.SaveAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='CloudFile-delete' name="CloudRole-delete" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>CloudFile.Delete( )</h3>
              <p>
              Saves the <code>CloudFile</code> object.
              </p>
              <div class="method-list">

                <h6>Returns</h6>
                <p>It returns a <code>CloudFile</code> object having <code>url</code> attribute set to <code>null</code> 
                if the operation is successful.<p>
                <h6>Error Handling</h6>
                It throws <code>CB.Exception.CloudBoostException</code>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
byte[] data = System.Text.Encoding.UTF8.GetBytes(".net cloudfile testing!");
string name = "sample.txt";
string type = "txt";
var file = new CB.CloudFile(data, name, type);
var rsponse = file.DeleteAsync();</span></span></code>
            </div><!-- method-example -->
                  <div class="clearfix"></div>
            
          </div> <!-- method-section -->

<div class="method">
<a id="Column" name="Column" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h1>CB.Column</h1>
<p>
This API allow to create a column object.
</p>
</div>
<div class="method-example" id="api-summary-example">
</div>
</div>
<a id="Column-constructor" name="Column-constructor" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CB.Column(<code>columnName, [dataType], [required], [unique]</code>)</h3>
<p>
Initialize a column.
<br>
List of valid <b>Data Type</b> is given below.
<br>
<b>Reqiure</b> is a boolean that indicate whether the field can be null or not.
<br>
<b>Unique</b> field is a boolean type, indicates whether should contains unique value or not.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl class="argument-list">
<dt>columnName</dt>
<dd class="">String <span>Column Name should not start with a number and should not contain any spaces and special characters.</span></dd>
<div class="clearfix"></div>
<dt>dataType</dt>
<dd class="">Cloud Data Types<span>Default data type is <b>Text</b></span></dd>
<div class="clearfix"></div>
<dt>required</dt>
<dd class="">Boolean <span>Default value is <b>False. </b></span></dd>
<div class="clearfix"></div>
<dt>unique</dt>
<dd class="">Boolean <span>Default value is <b>False. </b></span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>A cloudcolumn object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var column1 = new CB.Column("name", "Text", true, false);
var column2 = new CB.Column("uniqueId");
column2.dataType = "Number";
column2.unique = true;
column2.required = true;
var table = new CB.CloudTable("Employee");
table.AddColumn(column1);
table.AddColumn(column2);
await table.SaveAsync();
</span></span></code>
</div> 
</div>  
<a id="Column-datatype" name="Column-datatype" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Data Types</h3>
<p>List of Valid Data Types
</p><ul>
<li>Text</li>
<li>Number</li>
<li>Email</li>
<li>URL</li>
<li>Boolean</li>
<li>DateTime</li>
<li>GeoPoint</li>
<li>File</li>
<li>List</li>
<li>Relation</li>
<li>Object</li>
</ul>
<p><small><b>data types are case sensitive</b></small></p>
<p></p>
<p>
If you are using <b>Relation</b> as a data type then you need to set <b>relatedTo</b> property to column object.
<br>
Valid relatedTo data types for <b>Relation</b> is <b>CloudTable Object</b> i.e. just set the table name in relatedTo property.
</p>
<p>
If you are using <b>List</b> as a data type then you need to set <b>relatedTo</b> property to column object.
<br>
Valid relatedTo data types for <b>List</b> are:
<br>
['CloudTable Objects', 'Text', 'Email', 'URL', 'Number', 'Boolean', 'DateTime', 'Boolean', 'GeoPoint', 'File', 'Object']
</p>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request">
    <span class="prompt"></span>
    <span class="lang lang-node">
        <span class="highlight_js javascript">
var column3 = new CB.Column("department", "Relation", false, false);
column3.relatedTo = "DepartmentTable";
var column4 = new CB.Column("skills", "List", false, false);
column4.relatedTo = "Text";
var table = new CB.CloudTable("Employee");
table.AddColumn(column3);
table.AddColumn(column4);
await table.SaveAsync();
</span></span></code>
</div> 
</div>  
<div>  
<a id="Column-datatype" name="Column-required" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Required</h3>
<p> Used to set a column as required.</p>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var column3 = new CB.Column("department"");
column3.required = true;
</span></span></code>
</div> 
</div>  
<div>  
<a id="Column-datatype" name="Column-unique" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>Unique</h3>
<p> Used to set a column as unique.</p>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var column3 = new CB.Column("department");
column3.unique = true;
</span></span></code>
</div> 
</div>  
  
<div> 

<div class="method">
<a id="CloudTable" name="CloudTable" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h1>CB.CloudTable</h1>
<p>
This API allows to create, delete, get details of a table from an App by using <b>master-key.</b>
</p>
</div>
<div class="method-example" id="api-summary-example">
</div>
</div>
<a id="CloudTable-constructor" name="CloudTable-constructor" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CB.CloudTable(<code>tableName</code>)</h3>
<p>
All the tables are in CloudBoost is a type of CloudTable. Pass the table name as a parameter to initialize a CloudTable.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl class="argument-list">
<dt>tableName</dt>
<dd class="">String <span>Table should not start with a number and should not contain any spaces and special characters.</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>A CloudTable object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
<span class="keyword">var</span> table = <span class="keyword">new</span> CB.CloudTable(<span class="string">"TableName"</span>);
</span></span></code>
</div> 
</div>  
<a id="CloudTable-get" name="CloudTable-get" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.GetAsync(<code>CloudTable, [callback]</code>)</h3>
<p>
To get a table's detail of an App use get method.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl class="argument-list">
<dt>cloudtable</dt>
<dd class="">CloudTable Object <span>Pass a CloudTable Object</span></dd>
<dd>or</dd>
<dd class="">CloudTable <span>Pass a Name of CloudTable</span></dd>
<div class="clearfix"></div>
<dt>callback</dt>
<dd class="">Object <span>[optional] if provided must have success and error functions to handle respective response.</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>A CloudTable Object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudTable("Address");
CB.CloudTable table = await CB.CloudTable.GetAsync("Address");
</span></span></code>
</div> 
</div>  
<a id="CloudTable-getall" name="CloudTable-getall" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.GetAllAsync(<code>[callback]</code>)</h3>
<p>
It fetch all tables of an App.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl>
<dt>callback</dt>
<dd class="">Object <span>[optional] if provided must have success and error functions to handle respective response.</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>Array of CloudTable object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
List &lt;CB.CloudTable&gt; list = await CB.CloudTable.GetAllAsync();
</span></span></code>
</div> 
</div>  
<a id="CloudTable-addcolumn" name="CloudTable-addcolumn" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.AddColumn(<code>columnObj</code>)</h3>
<p>
Add a column to a table. go through <a href="https://docs.cloudboost.io/#Column">Column</a> to get more detail about how to initialize a column object.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl>
<dt>Column</dt>
<dd class="">Column Object<span>Create a Column object using Column Class and put this object as an Argument</span></dd>
<dd>or</dd>
<dd class="">Column Name<span>Pass the Column Name as the Argument</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>Void</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var table = new CB.CloudTable("Student");
var column = new CB.Column("Name", "Text", false, false);
table.addColumn(column);
await table.SaveAsync();
</span></span></code>
</div> 
</div>  
<a id="CloudTable-deletecolumn" name="CloudTable-deletecolumn" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.DeleteColumn(<code>columnObj</code>)</h3>
<p>
Delete a column of a Table. go through <a href="">Column</a> to get more detail about how to initialize a Column Object.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl>
<dt>Column</dt>
<dd class="">Column Object<span>Create a column object using Column Class and put this object as an argument</span></dd>
<dd>or</dd>
<dd class="">Column Name<span>Pass the Column Name as the Argument</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>Void</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var column = new CB.Column("Name", "Text", false, false);
table.DeleteColumn(column);
await table.SaveAsync();
</span></span></code>
</div> 
</div>  
<a id="CloudTable-save" name="CloudTable-save" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.SaveAsync(<code>[callback]</code>)</h3>
<p>
Save a CloudTable Object. It will automatically create all default columns for a table. If you want to create a user table or role table then just pass 'User' or 'Role' as an argument while creating cloudtable object.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl>
<dt>callback</dt>
<dd class="">Object <span>[optional] if provided must have success and error functions to handle respective response.</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>CloudTable Object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var table = new CB.CloudTable("NewTable");
awair table.SaveAsync();
</span></span></code>
</div> 
</div>  
<a id="CloudTable-delete" name="CloudTable-delete" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.DeleteAsync(<code>[callback]</code>)</h3>
<p>
Delete a CloudTable object i.e. delete a table of an App.
</p>
<div class="method-list">
<h6>Arguments</h6>
<dl>
<dt>callback</dt>
<dd class="">Object <span>[optional] if provided must have success and error functions to handle respective response.</span></dd>
<div class="clearfix"></div>
</dl>
<h6>Returns</h6>
<p>Success or Error Status</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var table = new CB.CloudTable("Student");
await table.DeleteAsync();
</span></span></code>
</div> 
</div>  
</div>  
<a id="CloudTable-getColumn" name="CloudTable-getColumn" class="section-anchor">&nbsp;</a>
<div class="method-section">
<div class="method-description">
<h3>CloudTable.Columns
<p>
Get's all columns list.
</p>
<div class="method-list">

<h6>Returns</h6>
<p>List of Cloud Column Object</p>
</div>
</div>
<div class="method-example" id="api-summary-example">
<code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
table.Columns
</span></span></code>
</div> 
</div>  
</div>
<a id='ACL' name="ACL" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">
              <h1>CB.ACL</h1>
              <p>
              Each <code>CloudObject</code> namespace has security option by default. By default every object can be read and modified by anyone so for each object change the security option as desidred.
              For any object, you can specify which users/roles are allowed to read the object, and which users/roles are allowed to modify an object. To support this type of security, each object has an access control list, implemented by the <code>ACL</code> class.
              </p>
              <p>
                For each object <code>ACL</code> object is a property in  <code>CloudObject.ACL</code> class.
              </p>
              <p>
                All the modifications in the ACL can be reflected only after the object is saved after the changes.
              </p>
            </div>
          </div>

          <a id='ACL-constructor' name="ACL-constructor" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>Constructor</h3>
              <p>
              Instantiates an <code>ACL</code> object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <p>It takes no argument</p>

                <h6>Returns</h6>
                <p>It returns nothing. It is called using a variable of which various parameters are set.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='ACL-setPublicWriteAccess' name="ACL-setPublicWriteAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetPublicWriteAccess( <code>value</code> )</h3>
              <p>
                To allow/disallow <i>public</i> to write on a particular CloudObject
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
              <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.SetPublicWriteAccess(false);

await obj.SaveAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='ACL-setPublicReadAccess' name="ACL-setPublicReadAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetPublicReadAccess( <code>value</code> )</h3>
              <p>
                To allow/disallow <i>public</i> to read a particular object
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">

                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
                          <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.SetPublicReadAccess(false);

await obj.SaveAsync();

</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='ACL-setUserWriteAccess' name="ACL-setUserWriteAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetUserWriteAccess( <code>userId, value</code> )</h3>
              <p>
                To allow/disallow user having to write on a particular object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">
                  
                  <dt>userId</dt>
                  <dd class="">string <span>The User ID of the user you want to set the access for</span></dd>
                  <div class="clearfix"></div>
                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
             <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.s=SetUserWriteAccess("idOfTheUser",true);

await obj.SaveAsync();

              </span></span></code>
                
            </div><!-- method-example -->
          </div> <!-- method-section -->
          <a id='ACL-setUserReadAccess' name="ACL-setUserReadAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetUserReadAccess( <code>userId, value</code> )</h3>
              <p>
                To allow/disallow user having <i>_id</i> <code>userId</code> to read a particular object.
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">
                  
                  <dt>userId</dt>
                  <dd class="">string <span>The user ID of the user you want to set the access for</span></dd>
                  <div class="clearfix"></div>
                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>It returns nothing.</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
                 <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.SetUserReadAccess("idOfTheUser",true);

await obj.SaveAsync();

              </span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

          <a id='ACL-setRoleWriteAccess' name="ACL-setRoleWriteAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetRoleWriteAccess( <code>roleId, value</code> )</h3>
              <p>
                To allow/disallow users of <i>roles</i> <code>roleId</code> to write on a particular object
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">
                  
                  <dt>roleId</dt>
                  <dd class="">string <span>The role ID of the Role you want to set the access for</span></dd>
                  <div class="clearfix"></div>
                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
                 <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.SetRoleWriteAccess("roleId", true);

await obj.SaveAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->


          <a id='ACL-setRoleReadAccess' name="ACL-setRoleReadAccess" class="section-anchor">&nbsp;</a>
          <div class="method-section">
            <div class="method-description">

              <h3>ACL.SetRoleReadAccess( <code>roleId, value</code> )</h3>
              <p>
                To allow/disallow users of <i>roles</i> <code>roleId</code> to read a particular object
              </p>
              <div class="method-list">
                
                <h6>Argument</h6>
                <dl class="argument-list">
                  
                  <dt>roleId</dt>
                  <dd class="">string <span>The role ID of the Role you want to set the access for</span></dd>
                  <div class="clearfix"></div>
                  <dt>value</dt>
                  <dd class="">boolean</dd>
                  <div class="clearfix"></div>
                  
                </dl>

                <h6>Returns</h6>
                <p>void</p>
              </div>
            </div>
            <div class="method-example" id="api-summary-example">
                 <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
var obj = new CB.CloudObject("Student");
obj.acl = new ACL();
obj.acl.SetWriteAccess("roleId", true);

await obj.SaveAsync();
</span></span></code>
            </div><!-- method-example -->
          </div> <!-- method-section -->

 
<div class="method">
  <a id='Contribute' name="Contribute" class="section-anchor">&nbsp;</a>
  <div class="method-section">
    <div class="method-description">

      <h1>Contribute</h1>
      <p>
      We heart contributors. Love what we do and want to contribute? <br/>

      JavaScript SDK : <a href="https://github.com/CloudBoost/JavaScriptSDK">GitHub Repository</a>

      <br/><br/>

      Our documentation is open source too! <br/><br/>

      Documentation : <a href="https://github.com/CloudBoost/api-reference">GitHub Repository</a> 
      </p>

    </div>
     <div class="method-example" id="api-summary-example">
      <code class="method-request"><span class="prompt"></span><span class="lang lang-node"><span class="highlight_js javascript">
01001101 01100001 01100100 01100101
01110111 01101001 01110100 01101000  
00111100 00110011 
      </span></span></code>
    </div><!-- method-example -->
  </div>
 
</div> <!-- method -->
	</div> <!-- methods -->
</div> <!-- api-docs -->
    <div class="footer">

    </div>

    <script src="assets/js/docs.js"></script>
    <script src="assets/js/highlight.pack.js"></script>
    <script src="assets/js/highlighter.js"></script>
    <script>
    
      /****Tracking*********/              
        mixpanel.track('Documentation Views');
      /****End of Tracking*****/

      var currentLangId="#javascript-sdk";
      var url = window.location.href;
      var urlParts=url.split("/");
      var currentAPI=urlParts[3];     
      

      if(currentAPI=="javascript.html" || currentAPI.indexOf("javascript.html")>-1){
        currentLangId="#javascript-sdk";
      }
      if(currentAPI=="java.html" || currentAPI.indexOf("java.html")>-1){
        currentLangId="#java-sdk";
      }
      if(currentAPI=="dotnet.html" || currentAPI.indexOf("dotnet.html")>-1){
        currentLangId="#dotnet-sdk";
      }
      if(currentAPI=="curl.html" || currentAPI.indexOf("curl.html")>-1){
        currentLangId="#curl-sdk";
      }
      _selectLanguage(currentLangId);

      $(document).ready(function(){
          $("#javascript-sdk").click(function(){            
            window.location.href="javascript.html";
            _selectLanguage("#javascript-sdk");
          });

          $("#java-sdk").click(function(){            
            window.location.href="java.html";
            _selectLanguage("#java-sdk");
          });

          $("#dotnet-sdk").click(function(){           
            window.location.href="dotnet.html";
            _selectLanguage("#dotnet-sdk");
          });

          $("#curl-sdk").click(function(){           
            window.location.href="curl.html";
            _selectLanguage("#curl-sdk");
          });

          $("#others-swagger").click(function(){           
            window.location.href="https://swagger.cloudboost.io";            
          });
      });

      function _selectLanguage(langId){
        //remove from all
        $("#javascript-sdk").removeClass("selected");
        $("#java-sdk").removeClass("selected");
        $("#dotnet-sdk").removeClass("selected");
        $("#curl-sdk").removeClass("selected");

        //select current
        $(langId).addClass("selected");
      } 
       
    </script>
  </body>
</html>