LaunchBoxContributors
On this page

StorefrontImportPresentation14.1

Class in Unbroken.LaunchBox.Plugins.Components.Storefronts

C#
public sealed class StorefrontImportPresentation
Identifies optional localized text and artwork used for a storefront provider's manual import entry points.

Remarks

Supplied text uses its fallback and optional package resource key. Omitted text retains host defaults.

Constructors

StorefrontImportPresentation

C#
public StorefrontImportPresentation(
    PluginText? header = null,
    PluginText? description = null,
    PluginText? menuItem = null,
    string? iconResourceId = null
)
Initializes a new instance of the StorefrontImportPresentation class.
header
The localizable text for a prominent import choice, or null.
description
The localizable text describing the import choice, or null.
menuItem
The localizable text for a compact import menu item, or null.
iconResourceId
The plugin image-resource ID for an import menu icon, or null.
Exception: ArgumentException
A supplied icon resource ID is empty, or neither text nor an icon is supplied.

Properties

  • DescriptionGets the localizable text describing the import choice.
  • HeaderGets the localizable text for a prominent import choice.
  • IconResourceIdGets the plugin image-resource ID for an import menu icon.
  • MenuItemGets the localizable text for a compact import menu item.
  • PlatformsGets or initializes optional canonical import platforms and the fallback platform.
  • WizardGets or initializes the optional localized presentation used by the host-owned manual import wizard.

Description

C#
public PluginText? Description { get; }
Gets the localizable text describing the import choice.

Header

C#
public PluginText? Header { get; }
Gets the localizable text for a prominent import choice.

IconResourceId

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

MenuItem

C#
public PluginText? MenuItem { get; }
Gets the localizable text for a compact import menu item.

Platforms

C#
public 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

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