LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

GameMetadataResult14.1 Beta

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

Constructors

GameMetadataResult 14.1 Beta

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

Properties

Diagnostics 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.GameData.GameDataDiagnostic> Diagnostics { get; }
Gets diagnostics.

Games 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.GameData.GameMetadata> Games { get; }
Gets the returned metadata.

IsComplete 14.1 Beta

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

Retry 14.1 Beta

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

Remarks

Return available partial items and set IsComplete to false when deferring. The host may repeat the original IDs, so retain successful work where appropriate. Return promptly instead of waiting inside the capability call.