Interface IPluginConfigurationStore

Represents a store that can save and retrieve an aribtrary configuration collection representing a single emulator configuration file, associated with a game record

Namespace: Snowflake.Extensibility.Configuration
Assembly: Snowflake.Framework.Primitives.dll
Syntax
public interface IPluginConfigurationStore
Remarks

To "delete" a configuration, just overwrite the existing values with a default instance

Methods

Get<T>()

Retrieves the configuration collection associated with this game record. This method is guaranteed to return a usable instance of the configuration collection. If a prior configuration has not been set, it should return a default instance with all properties initialized.

Declaration
IConfigurationSection<T> Get<T>()

    where T : class, IConfigurationSection<T>
Returns
Type Description
IConfigurationSection<T>

The configuration collection associated with this game record.

Type Parameters
Name Description
T

The type of configuration collection

GetAsync<T>()

Retrieves the configuration collection associated with this game record. This method is guaranteed to return a usable instance of the configuration collection. If a prior configuration has not been set, it should return a default instance with all properties initialized.

Declaration
Task<IConfigurationSection<T>> GetAsync<T>()

    where T : class, IConfigurationSection<T>
Returns
Type Description
System.Threading.Tasks.Task<IConfigurationSection<T>>

The configuration collection associated with this game record.

Type Parameters
Name Description
T

The type of configuration collection

Set(IConfigurationValue)

Updates a single existing configuration value, this will do nothing if the GUID is not found in the database.

Declaration
void Set(IConfigurationValue value)
Parameters
Type Name Description
IConfigurationValue value

The configuration value with valid GUID and updated data

Set(IEnumerable<IConfigurationValue>)

Updates multiple existing configuration values, this will do nothing for the GUID is not found in the database.

Declaration
void Set(IEnumerable<IConfigurationValue> values)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IConfigurationValue> values

The configuration value with valid GUID and updated data

Set<T>(IConfigurationSection<T>)

Saves and persists a configuration collection to the store.

Declaration
void Set<T>(IConfigurationSection<T> configuration)

    where T : class, IConfigurationSection<T>
Parameters
Type Name Description
IConfigurationSection<T> configuration

The configuration to save to the store
Type Parameters
Name Description
T

The type of configuration collection

SetAsync(IConfigurationValue)

Asynchronously updates a single existing configuration value, this will do nothing if the GUID is not found in the database.

Declaration
Task SetAsync(IConfigurationValue value)
Parameters
Type Name Description
IConfigurationValue value

The configuration value with valid GUID and updated data
Returns
Type Description
System.Threading.Tasks.Task

SetAsync(IEnumerable<IConfigurationValue>)

Asynchronously updates multiple existing configuration values, this will do nothing for the GUID is not found in the database.

Declaration
Task SetAsync(IEnumerable<IConfigurationValue> values)
Parameters
Type Name Description
System.Collections.Generic.IEnumerable<IConfigurationValue> values

The configuration value with valid GUID and updated data
Returns
Type Description
System.Threading.Tasks.Task

SetAsync<T>(IConfigurationSection<T>)

Saves and persists a configuration collection to the store.

Declaration
Task SetAsync<T>(IConfigurationSection<T> configuration)

    where T : class, IConfigurationSection<T>
Parameters
Type Name Description
IConfigurationSection<T> configuration

The configuration to save to the store
Returns
Type Description
System.Threading.Tasks.Task
Type Parameters
Name Description
T

The type of configuration collection