queryReferredFriend( )

Creates a query to retrieve a list of referred friends.

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

queryReferredFriend() runs with these ReferredFriendQueryBuilder defaults, which you can override:

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

The functions that are chained to queryReferredFriend() are applied in the order they're called. For example, if you apply ascending('status') and then descending('referringCustomerId'), the results are sorted first by the status, and then, if there are multiple results with the same status, the items are sorted by referring customer ID.

PROPERTY	SUPPORTED FILTERS & SORTING
referringCustomerId	eq(),ne(),exists(),in(),hasSome(),startsWith(),ascending(),descending()
status	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()