LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

This reference documents the current beta SDK. Beta APIs can change before stable.

PluginConnectionResult14.1 Beta

C#
public sealed class Unbroken.LaunchBox.Plugins.Connections.PluginConnectionResult
Reports a connection interaction outcome with localized validation errors.

Constructors

PluginConnectionResult 14.1 Beta

C#
public PluginConnectionResult(Unbroken.LaunchBox.Plugins.Connections.PluginConnectionOutcome outcome, string? connectionId = null, Unbroken.LaunchBox.Plugins.PluginText? errorMessage = null, System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText>? fieldErrors = null)
Creates an outcome.
outcome 14.1 Beta
Connected, Cancelled, or Failed.
connectionId 14.1 Beta
Required on success and absent otherwise.
errorMessage 14.1 Beta
Optional failure message.
fieldErrors 14.1 Beta
Optional failure errors keyed by form field ID.

Properties

ConnectionId 14.1 Beta

C#
public string? ConnectionId { get; }
Gets the connection handle on success.

ErrorMessage 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.PluginText? ErrorMessage { get; }
Gets the optional localized failure message.

FieldErrors 14.1 Beta

C#
public System.Collections.Generic.IReadOnlyDictionary<string, Unbroken.LaunchBox.Plugins.PluginText> FieldErrors { get; }
Gets an immutable snapshot of localized field errors.

Outcome 14.1 Beta

C#
public Unbroken.LaunchBox.Plugins.Connections.PluginConnectionOutcome Outcome { get; }
Gets the outcome.

Succeeded 14.1 Beta

C#
public bool Succeeded { get; }
Gets whether a usable connection was established.