LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IPluginConnectionCapability14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Connections.IPluginConnectionCapability
Provides account connections from an existing managed plugin component.

Remarks

One component supplies an owner within its package; other components may reference that owner. Authentication, refresh, service account identity, and permission policy belong to the plugin. Metadata getters must be local and inexpensive. Do not declare another manifest component for a secondary capability on the same class. Host connection presentation does not run in background workflows.

Properties

ConnectionDisplayName 14.1 Beta

C#
Unbroken.LaunchBox.Plugins.PluginText ConnectionDisplayName { get; }
Gets the account facility's localizable name.

ConnectionOwnerId 14.1 Beta

C#
string ConnectionOwnerId { get; }
Gets the stable, non-secret package-local owner ID, compared ordinally ignoring case.

Methods

DisconnectAsync 14.1 Beta

C#
System.Threading.Tasks.Task DisconnectAsync(string connectionId, System.Threading.CancellationToken cancellationToken)
Disconnects a connection and removes its stored credentials. Throw on failure.
connectionId 14.1 Beta
The owner-local execution handle, not a durable service account identity.
cancellationToken 14.1 Beta
Cancels the operation; cancellation does not undo completed persistence.

Returns

Completion of the provider's disconnect operation.

GetConnectionMethodsAsync 14.1 Beta

C#
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Connections.PluginConnectionMethod>> GetConnectionMethodsAsync(Unbroken.LaunchBox.Plugins.Connections.PluginConnectionRequest request, System.Threading.CancellationToken cancellationToken)
Gets fresh methods/presentations for connecting or reconnecting the requested connection.
request 14.1 Beta
The optional reconnect target. Do not disconnect it before successful replacement.
cancellationToken 14.1 Beta
Cancels retrieval.

Returns

Methods in provider-preferred order. An empty collection means no interaction is available.

GetConnectionsAsync 14.1 Beta

C#
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Connections.PluginConnection>> GetConnectionsAsync(System.Threading.CancellationToken cancellationToken)
Gets current connections; a successful empty result means no configured connection.
cancellationToken 14.1 Beta
Cancels retrieval.

Returns

Non-null descriptors with unique IDs. Throw on failed discovery instead of reporting logout.

Events

ConnectionsChanged 14.1 Beta

C#
event System.EventHandler? ConnectionsChanged
Signals that configured connections or their usability changed; observers reload state.