IPluginConnectionCapability14.1

Interface in Unbroken.LaunchBox.Plugins.Capabilities.Connections

public interface 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

ConnectionDisplayNameGets the account facility's localizable name.
ConnectionOwnerIdGets the stable, non-secret package-local owner ID, compared ordinally ignoring case.

ConnectionDisplayName

PluginText ConnectionDisplayName { get; }

Gets the account facility's localizable name.

ConnectionOwnerId

string ConnectionOwnerId { get; }

Gets the stable, non-secret package-local owner ID, compared ordinally ignoring case.

Methods

DisconnectAsyncDisconnects a connection and removes its stored credentials. Throw on failure.
GetConnectionMethodsAsyncGets fresh methods/presentations for connecting or reconnecting the requested connection.
GetConnectionsAsyncGets current connections; a successful empty result means no configured connection.

DisconnectAsync

Task DisconnectAsync(string connectionId, CancellationToken cancellationToken)

Disconnects a connection and removes its stored credentials. Throw on failure.

connectionId: The owner-local execution handle, not a durable service account identity.

cancellationToken: Cancels the operation; cancellation does not undo completed persistence.

Returns

Completion of the provider's disconnect operation.

GetConnectionMethodsAsync

Task<IReadOnlyCollection<PluginConnectionMethod>> GetConnectionMethodsAsync(
    PluginConnectionRequest request,
    CancellationToken cancellationToken
)

Gets fresh methods/presentations for connecting or reconnecting the requested connection.

request: The optional reconnect target. Do not disconnect it before successful replacement.

cancellationToken: Cancels retrieval.

Returns

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

GetConnectionsAsync

Task<IReadOnlyCollection<PluginConnection>> GetConnectionsAsync(
    CancellationToken cancellationToken
)

Gets current connections; a successful empty result means no configured connection.

cancellationToken: Cancels retrieval.

Returns

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

Events

ConnectionsChangedSignals that configured connections or their usability changed; observers reload state.

ConnectionsChanged

event EventHandler? ConnectionsChanged

Signals that configured connections or their usability changed; observers reload state.