Interface ISettingsStore

Where a SettingsEditor reads and changes settings: the app's own SettingsStore, or a running server's, e.g. through its admin socket.

Namespace: Uniform.Matrix.Hosting
Assembly: Uniform.Matrix.Hosting.dll
Syntax
public interface ISettingsStore

Properties

| Edit this page View Source

Path

The settings file.

Declaration
string Path { get; }
Property Value
Type Description
string

Methods

| Edit this page View Source

Apply(IReadOnlyDictionary<string, string?>)

Apply changes until the next start; a null value clears an applied change, so lower layers show again.

Declaration
void Apply(IReadOnlyDictionary<string, string?> changes)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
Exceptions
Type Condition
IOException

When the store cannot be reached.
| Edit this page View Source

GetSource(string)

Return which layer sets key: applied, command line, environment, a file name, or default.

Declaration
string GetSource(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string
| Edit this page View Source

GetValue(string)

Return the current value of key, e.g. Ui:InlineImages, or null when only the built-in default applies.

Declaration
string? GetValue(string key)
Parameters
Type Name Description
string key
Returns
Type Description
string
| Edit this page View Source

Save(IReadOnlyDictionary<string, string?>)

Write changes into the settings file, keeping its other settings; a null value removes the setting. The changes are applied too.

Declaration
void Save(IReadOnlyDictionary<string, string?> changes)
Parameters
Type Name Description
IReadOnlyDictionary<string, string> changes
Exceptions
Type Condition
IOException

When the file cannot be written, or the store cannot be reached.