mojio-js-sdk

<!DOCTYPE html> <html> <head> <meta charset='UTF-8'> <title>CoffeeScript API Documentation</title> <script src='../javascript/application.js'></script> <script src='../javascript/search.js'></script> <link rel='stylesheet' href='../stylesheets/application.css' type='text/css'> </head> <body> <div id='base' data-path='../'></div> <div id='header'> <div id='menu'> <a href='../alphabetical_index.html' title='Index'> Index </a> » <span class='title'>MojioModelSDK</span> </div> </div> <div id='content'> <h1> Class: MojioModelSDK </h1> <table class='box'> <tr> <td>Defined in:</td> <td>MojioModelSDK.coffee</td> </tr> </table> <h2>Overview</h2> <div class='docstring'> <p>The Model segment of the Mojio SDK. The model part of the SDK is the lowest level of the fluent chain and is used by all other SDK segments. It provides ways to specify the type of resource, identification of particular resources, and data for the resource.</p> </div> <div class='tags'> </div> <h2>Direct Known Subclasses</h2> <p class='children'> <a href='../class/MojioAuthSDK.html'>MojioAuthSDK</a> </p> <h2>Instance Method Summary</h2> <ul class='summary'> <li> <span class='signature'> <a href='#setup-dynamic'> # (void) <b>setup</b><span>(data)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#setCriteria-dynamic'> # (void) <b>setCriteria</b><span>(data)</span> </a> </span> <span class='desc'> </span> </li> <li> <span class='signature'> <a href='#users-dynamic'> # (object) <b>users</b><span>(data)</span> </a> </span> <span class='desc'> Specify a list of users to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#vehicles-dynamic'> # (object) <b>vehicles</b><span>(data)</span> </a> </span> <span class='desc'> Specify a list of vehicles to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#mojios-dynamic'> # (object) <b>mojios</b><span>(data)</span> </a> </span> <span class='desc'> Specify a list of mojios to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#trips-dynamic'> # (object) <b>trips</b><span>(data)</span> </a> </span> <span class='desc'> Specify a list of trips to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#apps-dynamic'> # (object) <b>apps</b><span>(data)</span> </a> </span> <span class='desc'> Specify a list of apps to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#groups-dynamic'> # (object) <b>groups</b><span>(data)</span> </a> </span> <span class='desc'> group </span> </li> <li> <span class='signature'> <a href='#permissions-dynamic'> # (object) <b>permissions</b><span>(data)</span> </a> </span> <span class='desc'> permissions </span> </li> <li> <span class='signature'> <a href='#images-dynamic'> # (object) <b>images</b><span>(data)</span> </a> </span> <span class='desc'> Specify an image to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#tags-dynamic'> # (object) <b>tags</b><span>(data)</span> </a> </span> <span class='desc'> Specify a tag to apply operations to in the fluent chain. </span> </li> <li> <span class='signature'> <a href='#details-dynamic'> # (object) <b>details</b><span>(data)</span> </a> </span> <span class='desc'> Return the changeable details of a resource </span> </li> <li> <span class='signature'> <a href='#histories-dynamic'> # (object) <b>histories</b><span>(measurement = null)</span> </a> </span> <span class='desc'> Return the changeable details of a resource </span> </li> <li> <span class='signature'> <a href='#states-dynamic'> # (object) <b>states</b><span>()</span> </a> </span> <span class='desc'> Return the changeable details of a resource </span> </li> <li> <span class='signature'> <a href='#locations-dynamic'> # (object) <b>locations</b><span>()</span> </a> </span> <span class='desc'> Return the changeable details of a resource </span> </li> <li> <span class='signature'> <a href='#mock-dynamic'> # (object) <b>mock</b><span>()</span> </a> </span> <span class='desc'> Create models for testing purposes. </span> </li> </ul> <h2>Instance Method Details</h2> <div class='methods'> <div class='method_details'> <p class='signature' id='setup-dynamic'> # (void) <b>setup</b><span>(data)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='setCriteria-dynamic'> # (void) <b>setCriteria</b><span>(data)</span> <br> </p> </div> <div class='method_details'> <p class='signature' id='users-dynamic'> # (object) <b>users</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a list of users to apply operations to in the fluent chain.</p><p>A list of users can be specified either with an array of users (id's or objects), or a query string. Pass null or undefined for all users accessible by the current user.</p> <div class='examples'> <h3>Examples:</h3> <h4> Observe a list of users. </h4> <pre><code class='coffeescript'>sdk.observe("key").users(["user_id1", "user_id2", { some user object }]).callback((error, result) -> ... )</code></pre> </div> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>users</span> <span class='type'> ( <tt>array or string</tt> ) </span> — <span class='desc'>A list of user ids or objects. A string will specify a query. </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='vehicles-dynamic'> # (object) <b>vehicles</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a list of vehicles to apply operations to in the fluent chain.</p><p>A list of vehicles can be specified either with an array of vehicles (id's or objects), or a query string. Pass null or undefined for all vehicles accessible by the current vehicle.</p> <div class='examples'> <h3>Examples:</h3> <h4> Observe a list of vehicles. </h4> <pre><code class='coffeescript'>sdk.observe("key").vehicles(["vehicle_id1", "vehicle_id2", { some vehicle object }]).callback((error, result) -> ... )</code></pre> </div> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>vehicles</span> <span class='type'> ( <tt>array or string</tt> ) </span> — <span class='desc'>A list of vehicle ids or objects. A string will specify a query. </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='mojios-dynamic'> # (object) <b>mojios</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a list of mojios to apply operations to in the fluent chain.</p><p>A list of mojios can be specified either with an array of mojios (id's or objects), or a query string. Pass null or undefined for all mojios accessible by the current mojio.</p> <div class='examples'> <h3>Examples:</h3> <h4> Observe a list of mojios. </h4> <pre><code class='coffeescript'>sdk.observe("key").mojios(["mojio_id1", "mojio_id2", { some mojio object }]).callback((error, result) -> ... )</code></pre> </div> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>mojios</span> <span class='type'> ( <tt>array or string</tt> ) </span> — <span class='desc'>A list of mojio ids or objects. A string will specify a query. </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='trips-dynamic'> # (object) <b>trips</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a list of trips to apply operations to in the fluent chain.</p><p>A list of trips can be specified either with an array of trips (id's or objects), or a query string. Pass null or undefined for all trips accessible by the current trip.</p> <div class='examples'> <h3>Examples:</h3> <h4> Observe a list of trips. </h4> <pre><code class='coffeescript'>sdk.observe("key").trips(["trip_id1", "trip_id2", { some trip object }]).callback((error, result) -> ... )</code></pre> </div> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>trips</span> <span class='type'> ( <tt>array or string</tt> ) </span> — <span class='desc'>A list of trip ids or objects. A string will specify a query. </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='apps-dynamic'> # (object) <b>apps</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a list of apps to apply operations to in the fluent chain.</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='groups-dynamic'> # (object) <b>groups</b><span>(data)</span> <br> </p> <div class='docstring'> <p>group</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='permissions-dynamic'> # (object) <b>permissions</b><span>(data)</span> <br> </p> <div class='docstring'> <p>permissions</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='images-dynamic'> # (object) <b>images</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify an image to apply operations to in the fluent chain. One image can be associated with either Vehicles or Users.</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='tags-dynamic'> # (object) <b>tags</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Specify a tag to apply operations to in the fluent chain. Tags are secondary resources associated with Vehicles, Mojios, Users, Groups, or Trips</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='details-dynamic'> # (object) <b>details</b><span>(data)</span> <br> </p> <div class='docstring'> <p>Return the changeable details of a resource</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='histories-dynamic'> # (object) <b>histories</b><span>(measurement = null)</span> <br> </p> <div class='docstring'> <p>Return the changeable details of a resource</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='states-dynamic'> # (object) <b>states</b><span>()</span> <br> </p> <div class='docstring'> <p>Return the changeable details of a resource</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='locations-dynamic'> # (object) <b>locations</b><span>()</span> <br> </p> <div class='docstring'> <p>Return the changeable details of a resource</p> </div> <div class='tags'> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> <div class='method_details'> <p class='signature' id='mock-dynamic'> # (object) <b>mock</b><span>()</span> <br> </p> <div class='docstring'> <p>Create models for testing purposes.</p><p>Mocks up objects for testing, objects are not persisted and are created with random values.</p> <div class='examples'> <h3>Examples:</h3> <h4> Create a Vehicle for unit testing </h4> <pre><code class='coffeescript'>sdk.mock().vehicle().callback((error, result) -> ... )</code></pre> </div> </div> <div class='tags'> <h3>Parameters:</h3> <ul class='param'> <li> <span class='name'>type</span> <span class='type'> ( <tt>string</tt> ) </span> — <span class='desc'>The model type: Vehicle, User, Mojio, or Trip. </span> </li> </ul> <h3>Returns:</h3> <ul class='return'> <li> <span class='type'></span> ( <tt>object</tt> ) — <span class='desc'>this </span> </li> </ul> </div> </div> </div> </div> <div id='footer'> November 17, 15 17:54:44 by <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'> Codo </a> 2.0.11 ✲ Press H to see the keyboard shortcuts ✲ <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a> ✲ <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a> </div> <iframe id='search_frame'></iframe> <div id='fuzzySearch'> <input type='text'> <ol></ol> </div> <div id='help'> <p> Quickly fuzzy find classes, mixins, methods, file: </p> <ul> <li> <span>T</span> Open fuzzy finder dialog </li> </ul> <p> Control the navigation frame: </p> <ul> <li> <span>L</span> Toggle list view </li> <li> <span>C</span> Show class list </li> <li> <span>I</span> Show mixin list </li> <li> <span>F</span> Show file list </li> <li> <span>M</span> Show method list </li> <li> <span>E</span> Show extras list </li> </ul> <p> You can focus and blur the search input: </p> <ul> <li> <span>S</span> Focus search input </li> <li> <span>Esc</span> Blur search input </li> </ul> </div> </body> </html>