eq( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query to match items where the specified property equals the specified value.

The eq() function refines a ReservationLocationsQueryBuilder to match only items where the value of the specified propertyName equals the specified value. eq() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. Matching strings with eq() is case-sensitive, so 'text' isn't equal to 'Text'.

Copy
function eq(propertyName: string, value: any): ReservationLocationsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Was this helpful?
Yes
No

find( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Returns the query results.

The find() function returns a Promise that resolves to the query results and metadata. The Promise is rejected if find() is called with insufficient permissions or if any of the previous functions used to refine the query are invalid.

Copy
function find(): Promise<ReservationLocationsQueryResult>
Request
This method does not take any parameters
Returns
Return Type:Promise<ReservationLocationsQueryResult>
Was this helpful?
Yes
No

in( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query to only match items where the specified property conatins any of the values in the provided array of values.

The in() function refines a ReservationLocationsQueryBuilder to match only items where the specified propertyName is equal to any of the values in the provided array. Matching strings with in() is case-sensitive, so 'text' isn't equal to 'Text'.

Copy
function in(propertyName: string, value: any): ReservationLocationsQueryBuilder
Method Parameters
propertyNamestring

valueany
Was this helpful?
Yes
No

limit( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Limits the number of items the query returns.

The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the next() and prev() functions to navigate the pages of a query result.

Copy
function limit(limit: number): ReservationLocationsQueryBuilder
Method Parameters
limitnumber

Limits the number of items the query returns.

The limit() function defines the number of results a query returns in each page. Only one page of results is retrieved at a time. You can use the next() and prev() functions to navigate the pages of a query result.

Was this helpful?
Yes
No

ne( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query to match items where the specified property doesn't equal the specified value.

The ne() function refines a ReservationLocationsQueryBuilder to match only items where the value of the specified propertyName doesn't equal the specified value. ne() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. Matching strings with ne() is case-sensitive, so 'text' isn't equal to 'Text'.

Copy
function ne(propertyName: string, value: any): ReservationLocationsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Was this helpful?
Yes
No

skipTo( )

Developer Preview

This API is subject to change. Bug fixes and new features will be released based on developer feedback throughout the preview period.

Refines a query that skips to a specific record.

The skipTo() function refines a ReservationLocationsQueryBuilder to return items that appear before or after the item pointed to by the provided cursor. Get the relevant cursor for a specific item from the cursors object in previous call's response. Then you can skip to cursors.prev to return items before the cursor, or cursors.next to return items after the cursor.

When using skipTo(), the filters and the sorting order of the original query can't be changed. Only the limit() property of the query can be changed.

Copy
function skipTo(cursor: string): ReservationLocationsQueryBuilder
Method Parameters
cursorstring

A pointer to specific record

Was this helpful?
Yes
No