LaunchBoxContributors
On this page

StorefrontPresentation14.1

Class in Unbroken.LaunchBox.Plugins.Components.Storefronts

C#
public sealed class StorefrontPresentation
Identifies optional localized text and artwork used to present a storefront provider.

Remarks

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

Constructors

StorefrontPresentation

C#
public StorefrontPresentation(
    PluginText? description = null,
    string? iconResourceId = null
)
Initializes a new instance of the StorefrontPresentation class.
description
The localizable text for the provider description, or null.
iconResourceId
The plugin image-resource ID for the provider icon, or null.
Exception: ArgumentException
A supplied icon resource ID is empty.

Properties

  • DescriptionGets the localizable text for the provider description.
  • IconResourceIdGets the plugin image-resource ID for the provider icon.
  • ImportGets the optional resources used for the provider's manual import entry points.
  • SearchAliasesGets or initializes additional names used by storefront searches.

Description

C#
public PluginText? Description { get; }
Gets the localizable text for the provider description.

IconResourceId

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

Import

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

SearchAliases

C#
public IReadOnlyList<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: ArgumentNullException
The collection or one of its entries is null.