LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IPluginCredentialStore14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.Connections.IPluginCredentialStore
Provides protected, package-scoped connection storage through constructor injection.

Remarks

Components in one managed package share records and notifications. Owner/connection handles are compared ordinally ignoring case; opaque value names are ordinal. These are not service account or game identities. Plugins coordinate their own refresh and client caches. Unreadable data fails without overwriting credentials. Unsubscribe event handlers when disposing a component. No cross-package storage access is provided.

Methods

GetConnectionsAsync 14.1 Beta

C#
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyCollection<Unbroken.LaunchBox.Plugins.Connections.PluginStoredConnection>> GetConnectionsAsync(string ownerId, System.Threading.CancellationToken cancellationToken)
Gets saved descriptors for an owner.
ownerId 14.1 Beta
The package-local owner ID.
cancellationToken 14.1 Beta
Cancels the read.

Returns

Saved descriptors, or an empty collection when none exist.

GetValueAsync 14.1 Beta

C#
System.Threading.Tasks.Task<string?> GetValueAsync(string ownerId, string connectionId, string name, System.Threading.CancellationToken cancellationToken)
Gets one opaque value.
ownerId 14.1 Beta
The package-local owner ID.
connectionId 14.1 Beta
The owner-local connection handle.
name 14.1 Beta
The case-sensitive value name.
cancellationToken 14.1 Beta
Cancels the read.

Returns

The value, or null when absent.

RemoveConnectionAsync 14.1 Beta

C#
System.Threading.Tasks.Task RemoveConnectionAsync(string ownerId, string connectionId, System.Threading.CancellationToken cancellationToken)
Removes a descriptor and its opaque values.
ownerId 14.1 Beta
The package-local owner ID.
connectionId 14.1 Beta
The owner-local connection handle.
cancellationToken 14.1 Beta
Cancels the operation.

Returns

Completion of protected persistence.

SaveConnectionAsync 14.1 Beta

C#
System.Threading.Tasks.Task SaveConnectionAsync(Unbroken.LaunchBox.Plugins.Connections.PluginStoredConnection connection, System.Collections.Generic.IReadOnlyDictionary<string, string?> values, System.Threading.CancellationToken cancellationToken)
Saves a descriptor and applies partial changes atomically with other host credential-store writes.
connection 14.1 Beta
The descriptor to save.
values 14.1 Beta
A non-null value adds or replaces its named value, a null value removes it, and an omitted name preserves its existing value.
cancellationToken 14.1 Beta
Cancels the operation; completed writes are not rolled back.

Returns

Completion of protected persistence.

Events

CredentialsChanged 14.1 Beta

C#
event System.EventHandler<Unbroken.LaunchBox.Plugins.Connections.PluginCredentialsChangedEventArgs>? CredentialsChanged
Signals a successful record change in this process; reload state instead of relying on exactly-once delivery.