LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

StorefrontGameMetadataResult14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadataResult
Contains provider metadata returned for a batch of games.

Constructors

StorefrontGameMetadataResult 14.1 Beta

C#
public StorefrontGameMetadataResult(System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadata> games, bool isComplete = true, System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontDiagnostic>? diagnostics = null)
Initializes a new instance of the Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadataResult class.
games 14.1 Beta
Metadata returned for individual provider games.
isComplete 14.1 Beta
Whether the provider completed every requested part of the operation.
diagnostics 14.1 Beta
Optional diagnostics explaining partial or failed metadata retrieval.

Properties

Diagnostics 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontDiagnostic> Diagnostics { get; }
Gets provider diagnostics associated with metadata retrieval.

Games 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadata> Games { get; }
Gets metadata returned for individual provider games.

IsComplete 14.1 Beta

C#
public bool IsComplete { get; }
Gets whether the provider completed every requested part of the operation.

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.