LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

StorefrontProviderImportWizardPresentationDescriptor14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportWizardPresentationDescriptor
Identifies optional localized text used by the host-owned manual import wizard.

Constructors

StorefrontProviderImportWizardPresentationDescriptor 14.1 Beta

C#
public StorefrontProviderImportWizardPresentationDescriptor(string? titleResourceKey = null, string? welcomeTitleResourceKey = null, string? welcomeDescriptionResourceKey = null, string? discoveryTitleResourceKey = null, string? discoveryDescriptionResourceKey = null, string? selectionDescriptionResourceKey = null, string? noAccessDescriptionResourceKey = null, string? noGamesDescriptionResourceKey = null)
titleResourceKey 14.1 Beta
The plugin string-resource key for the wizard window title.
welcomeTitleResourceKey 14.1 Beta
The plugin string-resource key for the welcome-page title.
welcomeDescriptionResourceKey 14.1 Beta
The plugin string-resource key for the welcome-page description.
discoveryTitleResourceKey 14.1 Beta
The plugin string-resource key for the game-discovery page title.
discoveryDescriptionResourceKey 14.1 Beta
The plugin string-resource key for the game-discovery page description.
selectionDescriptionResourceKey 14.1 Beta
The plugin string-resource key for the game-selection page description.
noAccessDescriptionResourceKey 14.1 Beta
The plugin string-resource key for the unavailable-library page description.
noGamesDescriptionResourceKey 14.1 Beta
The plugin string-resource key for the no-additional-games page description.

Properties

DiscoveryDescriptionResourceKey 14.1 Beta

C#
public string? DiscoveryDescriptionResourceKey { get; }
Gets the plugin string-resource key for the game-discovery page description.

DiscoveryTitleResourceKey 14.1 Beta

C#
public string? DiscoveryTitleResourceKey { get; }
Gets the plugin string-resource key for the game-discovery page title.

MediaOptions 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Storefronts.StorefrontProviderImportMediaOption> MediaOptions { get; init; }
Gets or initializes the provider media choices to add to the host-owned import wizard.

Remarks

Media types should normally use the canonical values exposed by Unbroken.LaunchBox.Plugins.Data.ImageTypes or Unbroken.LaunchBox.Plugins.Data.VideoTypes.

NoAccessDescriptionResourceKey 14.1 Beta

C#
public string? NoAccessDescriptionResourceKey { get; }
Gets the plugin string-resource key for the unavailable-library page description.

NoAccessHelpLabelResourceKey 14.1 Beta

C#
public string? NoAccessHelpLabelResourceKey { get; init; }
Gets or initializes the optional plugin string-resource key for the unavailable-library help link.

NoAccessHelpUri 14.1 Beta

C#
public System.Uri? NoAccessHelpUri { get; init; }
Gets or initializes an optional absolute help URI for the unavailable-library page.

NoGamesDescriptionResourceKey 14.1 Beta

C#
public string? NoGamesDescriptionResourceKey { get; }
Gets the plugin string-resource key for the no-additional-games page description.

PrioritizeStorefrontMetadataResourceKey 14.1 Beta

C#
public string? PrioritizeStorefrontMetadataResourceKey { get; init; }
Gets or initializes the optional plugin string-resource key for a choice that makes storefront metadata take precedence over other metadata sources during import.

Remarks

When omitted, the host does not show the choice and uses its normal metadata priority.

SelectionDescriptionResourceKey 14.1 Beta

C#
public string? SelectionDescriptionResourceKey { get; }
Gets the plugin string-resource key for the game-selection page description.

ShowEmuMoviesMediaOptions 14.1 Beta

C#
public bool ShowEmuMoviesMediaOptions { get; init; }
Gets or initializes whether the host should show its EmuMovies media choices in the import wizard.

SupportsManualSearch 14.1 Beta

C#
public bool SupportsManualSearch { get; init; }
Gets or initializes whether the host should offer to search local game files for PDF manuals.

TitleResourceKey 14.1 Beta

C#
public string? TitleResourceKey { get; }
Gets the plugin string-resource key for the wizard window title.

WelcomeDescriptionResourceKey 14.1 Beta

C#
public string? WelcomeDescriptionResourceKey { get; }
Gets the plugin string-resource key for the welcome-page description.

WelcomeTitleResourceKey 14.1 Beta

C#
public string? WelcomeTitleResourceKey { get; }
Gets the plugin string-resource key for the welcome-page title.