Class Index | File Index

Classes


Class KiiThingQuery

Represents a KiiThingQuery object
Defined in: KiiSDK.js.

Class Summary
Constructor Attributes Constructor Name and Description
 
Method Summary
Method Attributes Method Name and Description
 
Get the limit of the current query
 
Get the pagination key.
 
Get the thing type
 
setLimit(limit)
Set the limit of the given query
 
setPaginationKey(paginationKey)
Set the pagination key.
 
setThingType(thingType)
Set the thing type to filter the results.
<static>  
KiiThingQuery.thingQuery(owner, groups)
Construct KiiThingQuery.
Class Detail
KiiThingQuery()
Method Detail
{Number} getLimit()
Get the limit of the current query
Returns:
{Number}

{String} getPaginationKey()
Get the pagination key.
Returns:
{String}

{String} getThingType()
Get the thing type
Returns:
{String}

setLimit(limit)
Set the limit of the given query
Parameters:
limit
The maximum number of items obtained in one request.
If specified limit is <= 0, 0 will be applied. This limit behaves in a best effort way. Actual number of returned result can be smaller than the requested number.
If the specified limit is greater than the limit of the server or limit is set to 0, limit defined in server will be applied.

setPaginationKey(paginationKey)
Set the pagination key.
Parameters:
paginationKey
Pagination key

setThingType(thingType)
Set the thing type to filter the results.
Parameters:
thingType
Thing type

<static> KiiThingQuery.thingQuery(owner, groups)
Construct KiiThingQuery.
Both an owner and groups parameters are optional, but at least one of them must be supplied.
Parameters:
{KiiUser} owner Optional
of the thing. The user must be same as Login user or causes unauthorized error.
{KiiGroup[]} groups Optional
owns the thing. Login user must belongs to all groups or causes unauthorized error.
Throws:
{InvalidArgumentException}
neither an owner nor groups parameters are supplied.

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