Documentation

Class: FindAPI

FindAPI

Class representing a Find API

new FindAPI(Auth)

Create a new Find API

Parameters:
Name Type Description
Auth AuthAPI

Authorization to the API

Methods

exec(obj)

Execute the find

Parameters:
Name Type Description
obj Object

An object

Properties
Name Type Description
requests Array

An array of Request Objects
sorts Array

An array of Sort Objects
offset number

starting point of records to return
range number

how many records should be returned
portals Array

An array of Portal Objects
Returns:
  • A promise that resolves with multiple records
Type
Promise