LaunchBoxContributors
On this page

IGameCatalogCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public interface IGameCatalogCapability
Browses a source's game catalog independently of ownership, installation, matching, or achievement support.

Remarks

Implement with IGameDataSource on the same component. Metadata, media, and completion-time capabilities remain independently optional. These reads must not initiate account setup or modify the library.

Methods

GetGamesAsync

C#
Task<GameCatalogPage> GetGamesAsync(
    GameCatalogRequest request,
    CancellationToken cancellationToken
)
Retrieves one bounded catalog page.
request
Optional platform filter, page limit, and opaque continuation.
cancellationToken
Cancels retrieval.

Returns

A page containing at most the requested number of games and any already available artwork. Throw on failure or return explicit incomplete observations and diagnostics. Separate pages need not represent a fixed historical snapshot.
Exception: PluginAccountNotConfiguredException
A required account is confirmed absent. Do not use this signal for authentication or retrieval failures.

GetPlatformsAsync

C#
Task<IReadOnlyList<GameCatalogPlatform>> GetPlatformsAsync(
    CancellationToken cancellationToken
)
Lists the source-local platforms available for catalog filtering.
cancellationToken
Cancels retrieval.

Returns

Unique platform identities and names. An empty list means no platform filters are offered; unfiltered browsing remains available. Throw on failure instead of returning an empty list.
Exception: PluginAccountNotConfiguredException
A required account is confirmed absent. Do not use this signal for authentication or retrieval failures.