Class Index | File Index

Classes


Class KiiThingQueryResult

Represents a KiiThingQueryResult object
Defined in: KiiSDK.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Get the KiiThingQuery to get next page of the result.
 
getNextResult(Object)
Fetch the query result of next page.
 
Get the list of KiiThing that matches the query
 
When there are many result of query or data in result is large, Query result would be divided into several pages.
Class Detail
KiiThingQueryResult()
Method Detail
{KiiThingQuery} getNextKiiThingQuery()
Get the KiiThingQuery to get next page of the result.
Returns:
{KiiThingQuery} KiiThingQuery to get next page of the query. null when this result is the last part of the query.

{Promise} getNextResult(Object)
Fetch the query result of next page.

The query will be executed against the server, returning a result set. When the state that #hasNext() is false, method execution is failed and Promise returned by the method is rejected and failure callback is called if the callback is given.
Parameters:
Object
callbacks An object with callback methods defined
{Function} callbacks.success
The callback method to call on a successful query request
{Function} callbacks.failure
The callback method to call on a failed query request
Returns:
{Promise} return promise object.
  • fulfill callback function: function(result). result is KiiThingQueryResult instance.
  • reject callback function: function(error). error is an Error instance.
    • error.target is the KiiThing instance.
    • error.message

{Array} getResult()
Get the list of KiiThing that matches the query
Returns:
{Array} An array of KiiThing objects

{Boolean} hasNext()
When there are many result of query or data in result is large, Query result would be divided into several pages.
Returns:
{Boolean} true if there are pending result of the Query to be retrieved.

Documentation generated by JsDoc Toolkit 2.4.0 on Mon May 21 2018 05:13:33 GMT-0000 (UTC)