ascending( )

Developer Preview

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

Adds a sort to a query, sorting by the specified properties in ascending order.

The ascending() function refines a ContactsQueryBuilder to sort by the value of propertyName in ascending order. You can specify multiple properties for sorting in ascending order by passing each property name as an additional argument. ascending() sorts the results in the order the properties are passed. You can sort the following types:

  • Number: Sorts numerically.
  • Date: Sorts by date and time.
  • String: Sorts lexicographically, so 'abc' comes after 'XYZ'. If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
Copy
function ascending(propertyNames: Array<string>): ContactsQueryBuilder
Method Parameters
propertyNamesArray<string>

Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.

Returns
Was this helpful?
Yes
No

descending( )

Developer Preview

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

Adds a sort to a query, sorting by the specified properties in descending order.

The descending() function refines a ContactsQueryBuilder to sort by the value of propertyName in descending order. You can specify multiple properties for sorting in descending order by passing each property name as an additional argument. descending() sorts the results in the order the properties are passed. You can sort the following types:

  • Number: Sorts numerically.
  • Date: Sorts by date and time.
  • String: Sorts lexicographically, so 'abc' comes after 'XYZ'. If a property contains a number stored as a string (for example, '0'), that value is sorted alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest.
Copy
function descending(propertyNames: Array<string>): ContactsQueryBuilder
Method Parameters
propertyNamesArray<string>

Properties used in the sort. To sort by multiple properties, pass properties as additional arguments.

Returns
Was this helpful?
Yes
No

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 ContactsQueryBuilder 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): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
Was this helpful?
Yes
No

exists( )

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 contains a value.

The exists() function refines a ContactsQueryBuilder to only match items where the value of the specified propertyName doesn't equal null or undefined. exists() checks for either existence or non-existence based on the boolen parameter. Note that exists() does match items where the value of the specified propertyName is an empty string or an invalid value. exists() is only useful for properties which don't contain default values and therefore their values may be unassigned.

Copy
function exists(propertyName: string, value: boolean): ContactsQueryBuilder
Method Parameters
propertyNamestring

valueboolean
Returns
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<ContactsQueryResult>
Request
This method does not take any parameters
Returns
Return Type:Promise<ContactsQueryResult>
Was this helpful?
Yes
No

ge( )

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 is greater than or equal to the specified value.

The ge() function refines a ContactsQueryBuilder to match only items where the value of the specified propertyName is greater than or equal to the specified value. ge() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so 'abc' is greater than 'ABC'.
Copy
function ge(propertyName: string, value: any): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
Was this helpful?
Yes
No

gt( )

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 is greater than the specified value.

The gt() function refines a ContactsQueryBuilder to match only items where the value of the specified propertyName is greater than the specified value. gt() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so 'abc' is greater than 'ABC'.
Copy
function gt(propertyName: string, value: any): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
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 ContactsQueryBuilder 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): ContactsQueryBuilder
Method Parameters
propertyNamestring

valueany
Returns
Was this helpful?
Yes
No

le( )

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 is less than or equal to the specified value.

The le() function refines a ContactsQueryBuilder to match only items where the value of the specified propertyName is less than or equal to the specified value. le() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so 'ABC' is less than 'abc'.
Copy
function le(propertyName: string, value: any): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
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): ContactsQueryBuilder
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.

Returns
Was this helpful?
Yes
No

lt( )

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 is less than the specified value.

The le() function refines a ContactsQueryBuilder to match only items where the value of the specified propertyName is less than the specified value. le() matches only values of the same type. For example, 0 stored as a number doesn't match '0' stored as a string. If a property contains a number stored as a string (for example, '0'), that value is compared alphabetically and not numerically. If a property doesn't have a value, that value is ranked lowest. The following types of properties can be compared:

  • Number: Compares numerically.
  • Date: Compares JavaScript Date objects.
  • String: Compares lexicographically, so 'ABC' is less than 'abc'.
Copy
function lt(propertyName: string, value: any): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
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 ContactsQueryBuilder 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): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with value.


valueany

Value to compare against.

Returns
Was this helpful?
Yes
No

skip( )

Developer Preview

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

Sets the number of items to skip before returning query results.

The skip() function defines the number of results to skip before returning new query results. For example, if you query a collection and 50 items match your query, but you set skip() to 10, the first 10 items that match are ignored, and the 11th through 50th items are returned.

Copy
function skip(skip: number): ContactsQueryBuilder
Method Parameters
skipnumber

Sets the number of items to skip before returning query results.

The skip() function defines the number of results to skip before returning new query results. For example, if you query a collection and 50 items match your query, but you set skip() to 10, the first 10 items that match are ignored, and the 11th through 50th items are returned.

Returns
Was this helpful?
Yes
No

startsWith( )

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 starts with the specified value.

The startsWith() function refines a ContactsQueryBuilder to match only items where the value of the specified propertyName starts with the specified string. Matching with startsWith() is case-sensitive, so 'TEXT' doesn't start with 'text'. You can only use startsWith() with a property whose value is a string.

Copy
function startsWith(propertyName: string, value: string): ContactsQueryBuilder
Method Parameters
propertyNamestring

Property whose value is compared with string.


valuestring
Returns
Was this helpful?
Yes
No