Creates a query to retrieve a list of reviews.
The queryReviews() method builds a query to retrieve a list of reviews and returns a ReviewsQueryBuilder object.
The returned object contains the query definition, which is typically used to run the query using the find() method.
You can refine the query by chaining ReviewsQueryBuilder methods onto the query.
ReviewsQueryBuilder methods enable you to sort, filter,
and control the results that queryReviews() returns.
The queryReviews() method runs with the following defaults, which you can override:
ascending("_createdDate")limit(100)The methods that are chained to queryReviews() are applied in the order they're called. For example, if you apply descending("_createdDate") and then descending("content.rating"), the results are sorted first by the _createdDate, and then, if there are multiple results with the same _createdDate, the items are sorted by content.rating.
| PROPERTY | SUPPORTED FILTERS & SORTING |
|---|---|
namespace | eq(),ne(),in() |
entityId | eq(),ne(),in() |
_id | eq(),ne(),in() |
content.rating | eq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending() |
_createdDate | eq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending() |
author.contactId | eq(),ne(),in() |
helpfulness | eq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending() |
moderation.moderationStatus | eq(),ne(),in() |
verified | eq(),ne(),ascending(),descending() |
origin.type | eq(),ne(),ascending(),descending() |
relevanceScore | eq(),ne(),in(),lt(),le(),gt(),ge(),ascending(),descending() |
This method may require higher-level permissions than the caller has, based on their identity and roles and permissions. In these cases, you can ensure the method is called with the required level of authorization by using one of the following:
Information about the reviews to retrieve.
This method doesn't return any custom errors, but may return standard errors. Learn more about standard Wix errors.