14.1 Beta 1 SDK

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

PluginConfigurationValues14.1 Beta

public sealed class Unbroken.LaunchBox.Plugins.Forms.PluginConfigurationValues

Explicit configuration values for a plugin instance, including optional named scopes.

Remarks

Editing these values does not persist them. An empty scope is the base scope; named scopes inherit missing values from it. Names and field identifiers are compared without regard to case.

Constructors

public PluginConfigurationValues()

PluginConfigurationValues 14.1 Beta

public PluginConfigurationValues()

A summary has not been written for this member.

Properties

public System.Collections.Generic.IEnumerable<string> Scopes { get; }

Scopes 14.1 Beta

public System.Collections.Generic.IEnumerable<string> Scopes { get; }

Gets the stored scope names. An empty name denotes the base scope.

Methods

public Unbroken.LaunchBox.Plugins.Forms.PluginConfigurationValues Copy()
public string GetValue(string key, string? scopeName = null, bool inherit = true)
public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> GetValues(string? scopeName = null)
public bool HasValue(string key, string? scopeName = null)
public Unbroken.LaunchBox.Plugins.Forms.IPluginConfigurationValues Resolve(string? scopeName = null, Unbroken.LaunchBox.Plugins.Forms.PluginFormDefinition? defaults = null)
public void SetValue(string key, string? value, string? scopeName = null)

Copy 14.1 Beta

public Unbroken.LaunchBox.Plugins.Forms.PluginConfigurationValues Copy()

Creates an independent snapshot, including all scope overrides.

Returns

A copy that can be edited without changing this snapshot.

GetValue 14.1 Beta

public string GetValue(string key, string? scopeName = null, bool inherit = true)

Reads a setting, optionally inheriting from the base scope.

key 14.1 Beta: The form field identifier.

scopeName 14.1 Beta: The scope name, or null for the base scope.

inherit 14.1 Beta: Whether a missing scope override inherits the base scope value.

Returns

The stored value, or an empty string when unset.

GetValues 14.1 Beta

public System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<string, string>> GetValues(string? scopeName = null)

Gets the explicit values in one scope, without inherited values.

scopeName 14.1 Beta: The scope name, or null for the base scope.

Returns

The scope's field identifiers and values.

HasValue 14.1 Beta

public bool HasValue(string key, string? scopeName = null)

Reports whether the specified scope explicitly stores a setting.

key 14.1 Beta: The form field identifier.

scopeName 14.1 Beta: The scope name, or null for the base scope.

Returns

True when the scope has its own nonempty value.

Resolve 14.1 Beta

public Unbroken.LaunchBox.Plugins.Forms.IPluginConfigurationValues Resolve(string? scopeName = null, Unbroken.LaunchBox.Plugins.Forms.PluginFormDefinition? defaults = null)

Creates a view of one scope with optional form defaults for typed reads.

scopeName 14.1 Beta: The scope, or null for the base scope.

defaults 14.1 Beta: The form declaring field defaults, or null for runtime reads.

Returns

A view of this snapshot. Edits affect this snapshot only.

SetValue 14.1 Beta

public void SetValue(string key, string? value, string? scopeName = null)

Sets a value in this snapshot. Null or empty values remove the override.

key 14.1 Beta: The form field identifier. Blank keys are ignored.

value 14.1 Beta: The value to store, or null to clear it.

scopeName 14.1 Beta: The scope name, or null for the base scope.