LaunchBoxContributors
On this page

StorefrontPreparedAction14.1

Class in Unbroken.LaunchBox.Plugins.Components.Storefronts

C#
public sealed class StorefrontPreparedAction : PreparedAction
Describes one process-shaped storefront action selected by the provider.

Remarks

Providers select one truthful plan before returning. Arbitrary provider-authored action-step sequences are intentionally not part of this contract.

Inheritance and interfaces

Constructors

StorefrontPreparedAction

C#
public StorefrontPreparedAction(
    ActionPlan entryPlan,
    ActionPresentation presentation = DirectExecution,
    ActionObservation observation = EntryProcessStarted,
    ProviderItemData? proposedProviderData = null,
    StorefrontActionPrerequisite prerequisite = None
)
Initializes a new instance of the StorefrontPreparedAction class.
entryPlan
The process-shaped entry plan.
presentation
How the host should present and execute the plan.
observation
The evidence the host should use to determine progress or completion.
proposedProviderData
Optional updated provider game data for the host to persist.
prerequisite
A host-owned client prerequisite that must be fulfilled first. A client prerequisite requires IStorefrontClientRuntimeCapability and an installed client executable path.

Properties

  • PrerequisiteGets the host-owned client prerequisite that must be fulfilled first.
  • ProposedProviderDataGets optional updated provider game data for the host to persist.

Prerequisite

C#
public StorefrontActionPrerequisite Prerequisite { get; }
Gets the host-owned client prerequisite that must be fulfilled first.

Remarks

A provider returning a client prerequisite must implement IStorefrontClientRuntimeCapability and report an installed client with a known executable path through IStorefrontClientStateCapability.

ProposedProviderData

C#
public ProviderItemData? ProposedProviderData { get; }
Gets optional updated provider game data for the host to persist.