14.1 Beta 1 SDK
This reference documents the current beta SDK. Beta APIs can change before stable.
PluginFormResult14.1 Beta
public sealed class Unbroken.LaunchBox.Plugins.Forms.PluginFormResult
Reports whether a plugin form submission succeeded and describes any validation errors.
Constructors
public PluginFormResult(bool succeeded, string? errorMessage, System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText>? fieldErrors = null)public PluginFormResult(bool succeeded, Unbroken.LaunchBox.Plugins.PluginText? errorMessage = null, System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText>? fieldErrors = null)
PluginFormResult 14.1 Beta
public PluginFormResult(bool succeeded, string? errorMessage, System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText>? fieldErrors = null)Initializes a new instance of the Unbroken.LaunchBox.Plugins.Forms.PluginFormResult class.
succeeded14.1 Beta- Whether the plugin accepted the submitted values.
errorMessage14.1 Beta- An optional literal form-level error on failure.
fieldErrors14.1 Beta- Optional localizable errors keyed by form field ID on failure.
PluginFormResult 14.1 Beta
public PluginFormResult(bool succeeded, Unbroken.LaunchBox.Plugins.PluginText? errorMessage = null, System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText>? fieldErrors = null)Initializes a submission result with localizable, formattable errors.
succeeded14.1 Beta- Whether the plugin accepted the submitted values.
errorMessage14.1 Beta- An optional form-level error, including its fallback format.
fieldErrors14.1 Beta- Optional errors keyed by form field ID, each with a fallback format.
Properties
public Unbroken.LaunchBox.Plugins.PluginText? ErrorMessage { get; }public System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText> FieldErrors { get; }public bool Succeeded { get; }
ErrorMessage 14.1 Beta
public Unbroken.LaunchBox.Plugins.PluginText? ErrorMessage { get; }Gets the optional localizable, formattable form-level error.
FieldErrors 14.1 Beta
public System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText> FieldErrors { get; }Gets localizable, formattable errors keyed by form field ID, ignoring case.
Succeeded 14.1 Beta
public bool Succeeded { get; }Gets whether the plugin accepted the submitted values.