queryReferralRewards( )

Creates a query to retrieve a list of referral rewards.

The queryReferralRewards() function builds a query to retrieve a list of events and returns a ReferralRewardsQueryBuilder 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 ReferralRewardsQueryBuilder functions onto the query. ReferralRewardsQueryBuilder functions enable you to sort, filter, and control the results queryReferralRewards() returns.

queryReferralRewards() runs with these ReferralRewardsQueryBuilder defaults, which you can override:

• limit(50)
• descending("_createdDate")

The functions that are chained to queryReferralRewards() are applied in the order they're called. For example, if you apply ascending('rewardedReferredFriendId') and then descending('rewardType'), the results are sorted first by the referred friend ID, and then, if there are multiple results with the same ID, the items are sorted by reward type.

PROPERTY	SUPPORTED FILTERS & SORTING
rewardedReferringCustomerId	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
rewardedReferredFriendId	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
_createdDate	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
_updatedDate	eq(),ne(),exists(),in(),hasSome(),lt(),le(),gt(),ge(),ascending(),descending()
rewardType	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()