LaunchBoxContributors
On this page

LeaderboardRequest14.1

Class in Unbroken.LaunchBox.Plugins.Capabilities.Leaderboards

C#
public sealed class LeaderboardRequest
Selects a source-wide or game-specific player leaderboard.

Constructors

LeaderboardRequest

C#
public LeaderboardRequest()

A summary has not been written for this member.

Properties

  • CurrentAccountOnlyGets or initializes whether to retrieve only the configured player's entry, including placements outside the leading subset. This may require a configured connection and is independently supported for each board.
  • GameIdGets or initializes the source-local game ID; null selects the source-wide player ranking.
  • PeriodIdGets or initializes the period: all-time, weekly, monthly, or yearly. Other provider-defined IDs may be supported. Unsupported periods produce an unsupported result rather than a substituted board.

CurrentAccountOnly

C#
public bool CurrentAccountOnly { get; init; }
Gets or initializes whether to retrieve only the configured player's entry, including placements outside the leading subset. This may require a configured connection and is independently supported for each board.

GameId

C#
public string? GameId { get; init; }
Gets or initializes the source-local game ID; null selects the source-wide player ranking.

PeriodId

C#
public string PeriodId { get; init; }
Gets or initializes the period: all-time, weekly, monthly, or yearly. Other provider-defined IDs may be supported. Unsupported periods produce an unsupported result rather than a substituted board.