LaunchBoxContributors
On this page

GameMetadataResult14.1

Class in Unbroken.LaunchBox.Plugins.Components.GameData

C#
public sealed class GameMetadataResult
Contains metadata for a batch of games; an omitted game is unknown.

Constructors

GameMetadataResult

C#
public GameMetadataResult(
    IReadOnlyCollection<GameMetadata> games,
    bool isComplete = true,
    IReadOnlyCollection<GameDataDiagnostic>? diagnostics = null
)
Creates a result.
games
Metadata for the games the source could describe.
isComplete
Whether every requested part completed.
diagnostics
Optional diagnostics.

Properties

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

Diagnostics

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

Games

C#
public IReadOnlyCollection<GameMetadata> Games { get; }
Gets the returned metadata.

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.