PluginConnectionResult

PluginConnectionResult14.1

public sealed class PluginConnectionResult

Reports a connection interaction outcome with localized validation errors.

Constructors

PluginConnectionResultCreates an outcome.

public PluginConnectionResult(
    PluginConnectionOutcome outcome,
    string? connectionId = null,
    PluginText? errorMessage = null,
    IReadOnlyDictionary<string, PluginText>? fieldErrors = null
)

Creates an outcome.

outcome: Connected, Cancelled, or Failed.

connectionId: Required on success and absent otherwise.

errorMessage: Optional failure message.

fieldErrors: Optional failure errors keyed by form field ID.

Properties

ConnectionIdGets the connection handle on success.
ErrorMessageGets the optional localized failure message.
FieldErrorsGets an immutable snapshot of localized field errors.
OutcomeGets the outcome.
SucceededGets whether a usable connection was established.

ConnectionId

public string? ConnectionId { get; }

Gets the connection handle on success.

ErrorMessage

public PluginText? ErrorMessage { get; }

Gets the optional localized failure message.

FieldErrors

public IReadOnlyDictionary<string, PluginText> FieldErrors { get; }

Gets an immutable snapshot of localized field errors.

Outcome

public PluginConnectionOutcome Outcome { get; }

Gets the outcome.

Succeeded

public bool Succeeded { get; }

Gets whether a usable connection was established.