Methods

Usage

The library exposes methods common to all entity objects using the following syntax:

Ubidots.<entity>.<method>(args)

Available methods

all

Description: Returns a list containing all entity objects in the account.

Arguments: None

Signature: Ubidots.<entity>.all()

Return: [<entityObject>]

get

Description: Returns a list containing first 100 entity objects in the account.

Arguments: None

Signature: Ubidots.<entity>.get()

Return: [<entityObject>]

first

Description: Returns the first element in a list containing all entity objects in the account.

Arguments: None

Signature: Ubidots.<entity>.first()

Return: <entityObject>

paginate

Description: Performs a paginated request to retrieve entity objects. Similar to all() but paginated.

Arguments:

  • page: int [optional. Default -> 1] => The page number to retrieve.

  • size: int [optional. Default -> 100] => The maximum number of results per page.

Signature: Ubidots.<entity>.paginate(, [page, size])

Return: paginator object

Last updated