LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

StorefrontProviderPresentationDescriptor14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderPresentationDescriptor
Identifies optional localized text and artwork used to present a storefront provider.

Constructors

StorefrontProviderPresentationDescriptor 14.1 Beta

C#
public StorefrontProviderPresentationDescriptor(string? descriptionResourceKey = null, string? iconResourceId = null)
Initializes a new instance of the Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderPresentationDescriptor class.
descriptionResourceKey 14.1 Beta
The plugin string-resource key for the provider description, or null.
iconResourceId 14.1 Beta
The plugin image-resource ID for the provider icon, or null.
Exception: System.ArgumentException
A supplied resource reference is empty.

Properties

DescriptionResourceKey 14.1 Beta

C#
public string? DescriptionResourceKey { get; }
Gets the plugin string-resource key for the provider description.

IconResourceId 14.1 Beta

C#
public string? IconResourceId { get; }
Gets the plugin image-resource ID for the provider icon.

Import 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportPresentationDescriptor? Import { get; init; }
Gets the optional resources used for the provider's manual import entry points.

SearchAliases 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyList<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontSearchAliasDescriptor> SearchAliases { get; init; }
Gets or initializes additional names used by storefront searches.

Remarks

The host also searches the provider's literal and localized display names. Resolved aliases may be remembered while the provider is unavailable.
Exception: System.ArgumentNullException
The collection or one of its entries is null.