Class UserSettingsConfiguration

Namespace: RDCore.SDK.Server.Configuration

Assembly: RDCore.SDK.dll

Adds the settings a user set (UserSettingsStore) to the configuration of a platform application.

public static class UserSettingsConfiguration

Inheritance: object

UserSettingsConfiguration

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

AddUserSettings(IConfigurationBuilder, string, SettingsSchema, bool)

Adds the file of the user's settings to a configuration, after the deployed appsettings.json and before what the environment and the command line say: what a user set takes the place of what the platform was deployed with, and a process that is told otherwise when it is started is told so on purpose.

public static IConfigurationBuilder AddUserSettings(this IConfigurationBuilder builder, string path, SettingsSchema schema, bool reloadOnChange = false)

Parameters

builder IConfigurationBuilder: The configuration.
path string: The path of the file (PathIn(IPlatformEnvironment)).
schema SettingsSchema: The settings of the application.
reloadOnChange bool: Whether the file is read again when it changes; it is not, unless said otherwise.

Returns

IConfigurationBuilder

Remarks

A file that is not there is no setting, and neither is one that cannot be read: the platform starts as it was deployed. Of the file, only the values of settings of schema that a user can set, and that are values the setting can be, are read; whatever else it says is not - a file written by hand never keeps the platform from starting, and with it the client that could put it back. A setting the schema does not have is read as it is: it is another application's to check.