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 ActivityCountersQueryBuilder
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'
.
function eq(propertyName: string, value: any): ActivityCountersQueryBuilder
Property whose value is compared with value.
Value to compare against.
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.
function find(): Promise<ActivityCountersQueryResult>
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 ActivityCountersQueryBuilder
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'
.
function in(propertyName: string, value: any): ActivityCountersQueryBuilder
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.
function limit(limit: number): ActivityCountersQueryBuilder
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.
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 ActivityCountersQueryBuilder
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'
.
function ne(propertyName: string, value: any): ActivityCountersQueryBuilder
Property whose value is compared with value.
Value to compare against.
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.
function skip(skip: number): ActivityCountersQueryBuilder
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.