Home > @world-wide-lab/client > GetLeaderoardScoresOptions

GetLeaderoardScoresOptions interface

Options to get scores from a leaderboard when using Client.getLeaderboardScores()

Signature:

export interface GetLeaderoardScoresOptions

Properties

Property	Modifiers	Type	Description
aggregate?		"none" | "sum"	(Optional) Should scores be aggregated? If so, how?
cacheFor?		number	(Optional) Cache the result for this many seconds
limit?		number	(Optional) How many rows to return (maximally)
publicGroupName?		string	(Optional) Filter scores to only those with this publicGroupName.
publicIndividualName?		string	(Optional) Filter scores to only those with this publicIndividualName.
sort?		"desc" | "asc"	(Optional) In which direction to sort the scores (default is 'desc')
updatedAfter?		Date	(Optional) Only return scores that were updated after and including this timepoint. Can be used with oneWeekAgo(), oneMonthAgo() or oneYearAgo().