ILeaderboardManager14.1
Interface in Unbroken.LaunchBox.Plugins.Services.Leaderboards
public interface ILeaderboardManagerReads player rankings from installed leaderboard sources independently of profiles, achievements, and game data.
Remarks
Request this service by declaring a public constructor with an ILeaderboardManager parameter and call asynchronously after activation. Reads never sign in, submit scores, or expose provider instances or credentials. Caller cancellation throws OperationCanceledException; retrieval problems are reported in results.Methods
GetAsyncRetrieves a source-wide or game-specific leaderboard through the host's managed runtime.GetSourcesAsyncLists registered leaderboard sources without querying accounts or making network requests.
GetAsync
Task<PluginServiceResult<IReadOnlyList<LeaderboardEntry>>> GetAsync(
string sourceId,
LeaderboardRequest request,
CancellationToken cancellationToken
)Retrieves a source-wide or game-specific leaderboard through the host's managed runtime.
sourceId- The leaderboard source identity.
request- The game, period, and player selection.
cancellationToken- Cancels retrieval.
Returns
Read-only entries in provider ranking order, preserving ties and exact decimal scores. Empty Success means no entries for this selection; a leading subset is not a complete player directory. Unsupported selections return Unsupported; unavailable sources return ProviderUnavailable; other retrieval failures return Failed without data.Remarks
Each call attempts retrieval without a host result cache or automatic retry; IsStale is false and ObservedAt is null. Providers may reuse their own observations. Account changes discard pending results. This capability has no separate confirmed-missing-account signal: missing-account errors remain Failed rather than being inferred as Unconfigured from another capability or an empty board.GetSourcesAsync
Task<IReadOnlyList<PluginSourceInfo>> GetSourcesAsync(
CancellationToken cancellationToken
)Lists registered leaderboard sources without querying accounts or making network requests.
cancellationToken- Cancels the operation.