Class KiiThingQuery

Hierarchy

KiiThingQuery

Index

Methods

Methods

getLimit

getLimit(): number

- Defined in src/thingQuery.ts:67
Get the limit of the current query

Returns number

getPaginationKey

getPaginationKey(): string

- Defined in src/thingQuery.ts:99
Get the pagination key.

Returns string

getThingType

getThingType(): undefined | string

- Defined in src/thingQuery.ts:83
Get the thing type

Returns undefined | string

setLimit

setLimit(limit: number): void

- Defined in src/thingQuery.ts:55
Set the limit of the given query

Parameters
- limit: number
  
  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.
Returns void

setPaginationKey

setPaginationKey(paginationKey: string): void

- Defined in src/thingQuery.ts:91
Set the pagination key.

Parameters
- paginationKey: string
  
  Pagination key
Returns void

setThingType

setThingType(thingType: string): void

- Defined in src/thingQuery.ts:75
Set the thing type to filter the results.

Parameters
- thingType: string
  
  Thing type
Returns void

Static thingQuery

thingQuery(owner: null | KiiUser, groups?: null | KiiGroup[]): KiiThingQuery

- Defined in src/thingQuery.ts:39
Construct KiiThingQuery.
Both an owner and groups parameters are optional, but at least one of them must be supplied.

throws
{InvalidArgumentException} neither an owner nor groups parameters are supplied.

Parameters
- owner: null | KiiUser
- groups: null | KiiGroup[] = null
Returns KiiThingQuery

Generated using TypeDoc