LaunchBoxContributors
On this page

IPluginConfigurationFormsCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Capabilities.Configuration

C#
public interface IPluginConfigurationFormsCapability
Supplies framework-neutral, host-rendered configuration forms for a plugin component.

Remarks

Implement this optional capability on an existing plugin component. It does not declare a new component type or require a separate manifest capability or requested service. The host owns presentation; the plugin owns validation and persistence of submitted values.

Methods

GetConfigurationFormsAsync

C#
Task<IReadOnlyCollection<PluginConfigurationForm>> GetConfigurationFormsAsync(
    CancellationToken cancellationToken
)
Gets the configuration forms currently available from the plugin component.
cancellationToken
A token used to cancel configuration form retrieval.

Returns

A non-null collection of non-null configuration forms, or an empty collection when none are available. Form IDs must be unique within the collection returned by this capability, using ordinal comparison.

Remarks

Obtain configuration forms again when reopening configuration UI so that form defaults reflect current plugin state. Implementations must observe cancellation during asynchronous work.