LaunchBoxContributors
On this page

GameMediaResult14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public sealed class GameMediaResult
Contains media catalogs for a batch of games; an omitted game is unknown.

Constructors

GameMediaResult

C#
public GameMediaResult(
    IReadOnlyCollection<GameMediaCatalog> catalogs,
    bool isComplete = true,
    IReadOnlyCollection<GameDataDiagnostic>? diagnostics = null
)
Creates a result.
catalogs
Per-game catalogs.
isComplete
Whether every requested part completed.
diagnostics
Optional diagnostics.

Properties

  • CatalogsGets the catalogs.
  • DiagnosticsGets diagnostics.
  • IsCompleteGets whether the request completed.
  • RetryGets or initializes rate-limit deferral information. Null means no automatic retry is requested.

Catalogs

C#
public IReadOnlyCollection<GameMediaCatalog> Catalogs { get; }
Gets the catalogs.

Diagnostics

C#
public IReadOnlyCollection<GameDataDiagnostic> Diagnostics { get; }
Gets diagnostics.

IsComplete

C#
public bool IsComplete { get; }
Gets whether the request completed.

Retry

C#
public GameDataRetry? Retry { get; init; }
Gets or initializes rate-limit deferral information. Null means no automatic retry is requested.

Remarks

A deferred result can contain available partial items with IsComplete set to false. Retrying the original request may revisit items already returned. The retry policy belongs to the caller; the consumer service does not wait or retry automatically.