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 MarketingConsentQueryBuilder
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'
.
Property whose value is compared with value
.
Value to compare against.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
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.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
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.
Number of items to return, which is also the pageSize
of the results object.
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.
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 MarketingConsentQueryBuilder
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.
A pointer to specific record
This method doesn’t return any custom errors, but may return standard errors. Learn more about standard Wix errors.