Parse Arduino Yun SDK  1
Parse Arduino Yun SDK
Public Member Functions
ParseQuery Class Reference

Class responsible for query encapsulation. More...

#include <ParseQuery.h>

Inheritance diagram for ParseQuery:
ParseRequest

Public Member Functions

 ParseQuery ()
 Constructor of ParseCloudFunction object.
 
void whereExists (const char *key)
 Add a constraint for finding objects that contain the given key. More...
 
void whereDoesNotExist (const char *key)
 add a constraint for finding objects that does not contain the given key. More...
 
void whereEqualTo (const char *key, const char *value)
 add a constraint to the query that requires a particular key's value to be equal to the provided string value. More...
 
void whereNotEqualTo (const char *key, const char *value)
 add a constraint to the query that requires a particular key's value not equal to the provided string value. More...
 
void whereEqualTo (const char *key, bool value)
 add a constraint to the query that requires a particular key's value to be equal to the provided boolean value. More...
 
void whereNotEqualTo (const char *key, bool value)
 add a constraint to the query that requires a particular key's value to be equal to the provided string value. More...
 
void whereEqualTo (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be equal to the provided string value. More...
 
void whereNotEqualTo (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be equal to the provided string value. More...
 
void whereLessThan (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be less than the provided value. More...
 
void whereGreaterThan (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be greater than the provided value. More...
 
void whereLessThanOrEqualTo (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be less than or equal to the provided value. More...
 
void whereGreaterThanOrEqualTo (const char *key, int value)
 add a constraint to the query that requires a particular key's value to be greater than or equal to the provided value. More...
 
void whereEqualTo (const char *key, double value)
 add a constraint to the query that requires a particular key's value to be equal to the provided value. More...
 
void whereNotEqualTo (const char *key, double value)
 add a constraint to the query that requires a particular key's value not equal to the provided double value. More...
 
void whereLessThan (const char *key, double value)
 add a constraint to the query that requires a particular key's value to be less than the provided value. More...
 
void whereGreaterThan (const char *key, double value)
 add a constraint to the query that requires a particular key's value to be greater than the provided value. More...
 
void whereLessThanOrEqualTo (const char *key, double value)
 add a constraint to the query that requires a particular key's value to be less than or equal to the provided value. More...
 
void whereGreaterThanOrEqualTo (const char *key, double value)
 add a constraint to the query that requires a particular key's value to be greater than or equal to the provided value. More...
 
void setLimit (int n)
 controls the maximum number of results that are returned. More...
 
void setSkip (int n)
 controls the number of results to skip before returning any results. More...
 
void setKeys (const char *keys)
 restrict the fields of returned ParseObjects to only include the provided keys. More...
 
void orderBy (const char *keys)
 sorts the results in ascending/descending order by the given key. More...
 
ParseResponse send () override
 launch query and execute More...
 
- Public Member Functions inherited from ParseRequest
 ParseRequest ()
 Constructor of ParseRequest object.
 
 ~ParseRequest ()
 Destructor of ParseRequest object.
 
void setClassName (const char *className)
 set the ParseObject class name in which request will be performed. More...
 
void setObjectId (const char *objectId)
 set the ParseObject object id in which request will be performed. More...
 

Additional Inherited Members

- Protected Attributes inherited from ParseRequest
String httpPath
 
String requestBody
 
bool isBodySet
 

Detailed Description

Class responsible for query encapsulation.

Member Function Documentation

void ParseQuery::orderBy ( const char *  key)

sorts the results in ascending/descending order by the given key.

Parameters
keys- Keys to sort on. use "field_name" for ascending order use a negative sign "-field_name" for descending order seperate multiple keys with comma e.g. "score,-name"
ParseResponse ParseQuery::send ( )
overridevirtual

launch query and execute

Returns
response of the request.

Implements ParseRequest.

void ParseQuery::setKeys ( const char *  keys)

restrict the fields of returned ParseObjects to only include the provided keys.

Parameters
keys- Keys to include. seperate multiple keys with comma e.g. "score,name"
void ParseQuery::setLimit ( int  n)

controls the maximum number of results that are returned.

controls the maximum number of results that are returned. setting a negative limit denotes retrieval without a limit. the default limit is 100, with a maximum of 1000 results being returned at a time.

Parameters
n- limit.
void ParseQuery::setSkip ( int  n)

controls the number of results to skip before returning any results.

Parameters
n- number to skip.
void ParseQuery::whereDoesNotExist ( const char *  key)

add a constraint for finding objects that does not contain the given key.

Parameters
key- the key that should not exist.
void ParseQuery::whereEqualTo ( const char *  key,
const char *  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided string value.

Parameters
key- The key to check.
value- The value that the ParseObject must contain.
void ParseQuery::whereEqualTo ( const char *  key,
bool  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided boolean value.

Parameters
key- The key to check.
value- The value that the ParseObject must contain.
void ParseQuery::whereEqualTo ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided string value.

Parameters
key- The key to check.
value- The value that the ParseObject must contain.
void ParseQuery::whereEqualTo ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided value.

Parameters
key- The key to check.
value- The value that the ParseObject must contain.
void ParseQuery::whereExists ( const char *  key)

Add a constraint for finding objects that contain the given key.

Parameters
key- the key that should exist.
void ParseQuery::whereGreaterThan ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be greater than the provided value.

Parameters
key- The key to check.
value- The value that provides an lower bound.
void ParseQuery::whereGreaterThan ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value to be greater than the provided value.

Parameters
key- The key to check.
value- The value that provides an lower bound.
void ParseQuery::whereGreaterThanOrEqualTo ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be greater than or equal to the provided value.

Parameters
key- The key to check.
value- The value that provides an lower bound.
void ParseQuery::whereGreaterThanOrEqualTo ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value to be greater than or equal to the provided value.

Parameters
key- The key to check.
value- The value that provides an lower bound.
void ParseQuery::whereLessThan ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be less than the provided value.

Parameters
key- The key to check.
value- The value that provides an upper bound.
void ParseQuery::whereLessThan ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value to be less than the provided value.

Parameters
key- The key to check.
value- The value that provides an upper bound.
void ParseQuery::whereLessThanOrEqualTo ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be less than or equal to the provided value.

Parameters
key- The key to check.
value- The value that provides an upper bound.
void ParseQuery::whereLessThanOrEqualTo ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value to be less than or equal to the provided value.

Parameters
key- The key to check.
value- The value that provides an upper bound.
void ParseQuery::whereNotEqualTo ( const char *  key,
const char *  value 
)

add a constraint to the query that requires a particular key's value not equal to the provided string value.

Parameters
key- The key to check.
value- The value that must not be equalled.
void ParseQuery::whereNotEqualTo ( const char *  key,
bool  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided string value.

Parameters
key- The key to check.
value- The value that must not be equalled.
void ParseQuery::whereNotEqualTo ( const char *  key,
int  value 
)

add a constraint to the query that requires a particular key's value to be equal to the provided string value.

Parameters
key- The key to check.
value- The value that must not be equalled.
void ParseQuery::whereNotEqualTo ( const char *  key,
double  value 
)

add a constraint to the query that requires a particular key's value not equal to the provided double value.

Parameters
key- The key to check.
value- The value that must not be equalled.

The documentation for this class was generated from the following files: