LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IStorefrontGameMetadataCapability14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Storefronts.IStorefrontGameMetadataCapability
Supplies provider metadata for batches of provider-local game IDs.

Properties

SupportsMetadataPriority 14.1 Beta

C#
bool SupportsMetadataPriority { get; }
Gets whether the host should offer a choice to prioritize this provider's descriptive metadata over the Games Database.

Remarks

Defaults to true. Return false when metadata only supplies titles or media, which use separate host policies. This does not disable metadata or media retrieval.

Methods

GetGameMetadataAsync 14.1 Beta

C#
System.Threading.Tasks.Task<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadataResult> GetGameMetadataAsync(Unbroken.LaunchBox.Plugins.Storefronts.StorefrontGameMetadataRequest request, System.Threading.CancellationToken cancellationToken)
Gets metadata for the requested games.
request 14.1 Beta
The game IDs and optional requested media types.
cancellationToken 14.1 Beta
A token used to cancel the operation.

Returns

The returned metadata, completeness flag, and diagnostics.