LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

StorefrontProviderImportPresentationDescriptor14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportPresentationDescriptor
Identifies optional localized text and artwork used for a storefront provider's manual import entry points.

Constructors

StorefrontProviderImportPresentationDescriptor 14.1 Beta

C#
public StorefrontProviderImportPresentationDescriptor(string? headerResourceKey = null, string? descriptionResourceKey = null, string? menuItemResourceKey = null, string? iconResourceId = null)
Initializes a new instance of the Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportPresentationDescriptor class.
headerResourceKey 14.1 Beta
The plugin string-resource key for a prominent import choice, or null.
descriptionResourceKey 14.1 Beta
The plugin string-resource key describing the import choice, or null.
menuItemResourceKey 14.1 Beta
The plugin string-resource key for a compact import menu item, or null.
iconResourceId 14.1 Beta
The plugin image-resource ID for an import menu icon, or null.
Exception: System.ArgumentException
A supplied resource reference is empty, or no resource reference is supplied.

Properties

DescriptionResourceKey 14.1 Beta

C#
public string? DescriptionResourceKey { get; }
Gets the plugin string-resource key describing the import choice.

HeaderResourceKey 14.1 Beta

C#
public string? HeaderResourceKey { get; }
Gets the plugin string-resource key for a prominent import choice.

IconResourceId 14.1 Beta

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

MenuItemResourceKey 14.1 Beta

C#
public string? MenuItemResourceKey { get; }
Gets the plugin string-resource key for a compact import menu item.

Platforms 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Storefronts.StorefrontImportPlatforms? Platforms { get; init; }
Gets or initializes optional canonical import platforms and the fallback platform.

Remarks

The shared wizard supports per-game platform choices when multiple platforms are declared. Positive import-preparation hints take precedence over metadata guesses; user selections take precedence over both. Omission retains the ordinary single-platform flow.

Wizard 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportWizardPresentationDescriptor? Wizard { get; init; }
Gets or initializes the optional localized presentation used by the host-owned manual import wizard.