queryReviewRequests( )

Creates a query to retrieve a list of review requests.

The queryReviewRequests() function builds a query to retrieve a list of review requests and returns a ReviewRequestsQueryBuilder object.

The returned object contains the query definition, which is typically used to run the query using the find() function.

You can refine the query by chaining ReviewRequestsQueryBuilder functions onto the query. ReviewRequestsQueryBuilder functions enable you to sort, filter, and control the results that queryReviewRequests() returns.

queryReviewRequests() runs with the following ReviewRequestsBuilder default that you can override:

• ascending("_createdDate")

The functions that are chained to queryReviewRequests() are applied in the order they are called. For example, if you apply in("items.catalogItemId") and then ("requestedBy.appId"), the results are sorted first by the "items.catalogItem", and then, if there are multiple results with the same "items.catalogItem", the items are sorted by "appId".

The following ReviewRequestsQueryBuilder functions are supported for the queryReviewRequests() function. For a full description of the review request object, see the object returned for the items property in ReviewRequestsQueryResult.

PROPERTY	SUPPORTED FILTERS & SORTING
_id	eq(),ne(),in()
_createdDate	eq(),ne(),gt(),ge(),lt(),le(),in(),ascending(),descending()
sendDate	eq(),ne(),gt(),ge(),lt(),le(),in(),ascending(),descending()
namespace	eq(),ne(),in()
order.id	eq(),ne(),in(),exists()
items.catalogItemId	eq(),ne(),in()
items.reviewId	eq(),ne(),in(),exists()
recipient.contactId	eq(),ne(),in()
communicationChannel	eq(),ne(),in()
status	eq(),ne(),in(),ascending(),descending()
automationActivationId	eq(),ne(),in(),exists()
requestedBy.wixUserId	eq(),ne(),in()
requestedBy.appId	eq(),ne(),in()
requestedBy.identityType	eq(),ne(),in()