LaunchBoxContributors
On this page

GameCatalogPage14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public sealed class GameCatalogPage
Contains one catalog page using existing game metadata and media payloads.

Constructors

GameCatalogPage

C#
public GameCatalogPage(
    IReadOnlyCollection<GameMetadata> games,
    IReadOnlyCollection<GameMediaCatalog>? media = null,
    string? nextPageToken = null,
    bool isPageComplete = true,
    IReadOnlyCollection<GameDataDiagnostic>? diagnostics = null
)
Creates a page of unique games and optional artwork.
games
Ordered game entries. Sparse metadata remains unknown and needs no per-game detail retrieval.
media
Optional unique media catalogs belonging to games in this page. Preview-only catalogs should be marked incomplete.
nextPageToken
Opaque continuation of at most 4096 characters. Null ends browsing only when IsPageComplete is true. Incomplete pages must not advance the continuation.
isPageComplete
Whether this page was successfully retrieved; independent of reaching the end of the whole catalog or populating every optional field.
diagnostics
Existing game-data diagnostics for this page.

Properties

  • DiagnosticsGets existing game-data diagnostics.
  • GamesGets the ordered game entries.
  • IsPageCompleteGets whether retrieval of this page completed. False never establishes that browsing reached the end.
  • MediaGets artwork already available for games in this page. Omitted artwork is unknown.
  • NextPageTokenGets the next-page token. Short or empty pages can have a continuation.
  • RetryGets or initializes rate-limit deferral information. Retain partial data without advancing the continuation.

Diagnostics

C#
public IReadOnlyCollection<GameDataDiagnostic> Diagnostics { get; }
Gets existing game-data diagnostics.

Games

C#
public IReadOnlyCollection<GameMetadata> Games { get; }
Gets the ordered game entries.

IsPageComplete

C#
public bool IsPageComplete { get; }
Gets whether retrieval of this page completed. False never establishes that browsing reached the end.

Media

C#
public IReadOnlyCollection<GameMediaCatalog> Media { get; }
Gets artwork already available for games in this page. Omitted artwork is unknown.

NextPageToken

C#
public string? NextPageToken { get; }
Gets the next-page token. Short or empty pages can have a continuation.

Retry

C#
public GameDataRetry? Retry { get; init; }
Gets or initializes rate-limit deferral information. Retain partial data without advancing the continuation.

Remarks

Honor CanRetry, RetryAfter, and CountsAsAttempt before any bounded retry of the same page request. Null supplies no rate-limit guidance; it does not require or prohibit retrying a transient failure.