LaunchBoxCONTRIBUTORS
On this page

14.1 Beta 1 SDK

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

IPluginDataStore14.1 Beta

C#
public interface Unbroken.LaunchBox.Plugins.IPluginDataStore
Provides persistent, non-secret storage scoped to the requesting plugin.

Methods

GetValueAsync 14.1 Beta

C#
System.Threading.Tasks.Task<byte[]?> GetValueAsync(Unbroken.LaunchBox.Plugins.PluginDataStoreGetArgs args, System.Threading.CancellationToken cancellationToken)
Gets the requested value, or null when no value exists.
args 14.1 Beta
The plugin-local key identifying the value.
cancellationToken 14.1 Beta
A token requesting cancellation of the operation.

Returns

The stored bytes, or null when the key has no value. The plugin owns the serialized format.

RemoveValueAsync 14.1 Beta

C#
System.Threading.Tasks.Task RemoveValueAsync(Unbroken.LaunchBox.Plugins.PluginDataStoreRemoveArgs args, System.Threading.CancellationToken cancellationToken)
Removes the requested value.
args 14.1 Beta
The plugin-local key identifying the value to remove.
cancellationToken 14.1 Beta
A token requesting cancellation of the operation.

Returns

A task representing the removal operation.

SetValueAsync 14.1 Beta

C#
System.Threading.Tasks.Task SetValueAsync(Unbroken.LaunchBox.Plugins.PluginDataStoreSetArgs args, System.Threading.CancellationToken cancellationToken)
Stores the requested value.
args 14.1 Beta
The plugin-local key and bytes to persist.
cancellationToken 14.1 Beta
A token requesting cancellation of the operation.

Returns

A task representing the storage operation.