queryReferralEvent( )

Creates a query to retrieve a list of referral events.

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

queryReferralEvents() runs with these ReferralEventsQueryBuilder defaults, which you can override:

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

The functions that are chained to queryReferralEvents() are applied in the order they're called. For example, if you apply ascending('actionEvent') and then descending('rewardEvent'), the results are sorted first by the action events, and then, if there are multiple results with the same action events, the items are sorted by reward events.

PROPERTY	SUPPORTED FILTERS & SORTING
referredFriendSignupEvent	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
successfulReferralEvent	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
actionEvent	eq(),ne(),exists(),in(),hasSome(),ascending(),descending()
rewardEvent	eq(),ne(),exists(),in(),hasSome(),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()