Class CoreConfig

Inheritance
object
CoreConfig
Inherited Members
Namespace: Estrelica
Assembly: Estrelica.Core.Config.Mock.dll
Syntax
public static class CoreConfig

Methods

GetConfigOverrideKeys(string, string, bool)

Declaration
public static IEnumerable<string> GetConfigOverrideKeys(string appConfigFilename = null, string userSecretsId = null, bool includeDisabled = false)
Parameters
string appConfigFilename

string userSecretsId

bool includeDisabled

Returns
IEnumerable<string>

Load(Action<Exception>, string, string, bool, string, string, Func<string>, Func<string, bool>, string, Action<Settings>)

Invokes an instance of Estrelica Core by validating the current license and establishing a session with Archer using configuration values set in a JSON config file (defaults to appSetttings.config in the current working directory) with potential override values supplied in an optional user secrets file id. The settings file is itself optional if a user secrets file id is provided (or specified in your .csproj file) and it resolves a file containing all necessary values. See https://castlehillsoftware.github.io/Estrelica.Core.Demos/articles/manage_configuration.html

Declaration
public static Core Load(Action<Exception> warningCallback, string appConfigFilename = null, string userSecretsId = null, bool forceRefresh = false, string configOverrideKey = null, string licenseFileLocation = null, Func<string> loadLicense = null, Func<string, bool> saveLicense = null, string existingSessionToken = null, Action<CoreConfig.Settings> settingsPreview = null)
Parameters
Action<Exception> warningCallback

string appConfigFilename

string userSecretsId

The id of your user secrets file. Defaults to "Estrelica.Core" if not explicitly set. May also be specified by the inclusion of a UserSecretsIdAttribute in your project (generated by the compiler in you have defined in your .csproj file).
bool forceRefresh

If true, forces a license refresh regardless of license stale state.
string configOverrideKey

string licenseFileLocation

By default the Estrelica.Core.license file is stored in the current operating directory. Use this if you want to maintain it somewhere else.
Func<string> loadLicense

Func<string, bool> saveLicense

string existingSessionToken

Action<CoreConfig.Settings> settingsPreview

Returns
Core

Remarks

If not specified, the userSecretsId will default to "Estrelica.Core", allowing a single user secrets file (if available) to be used for all projects without the need to explicity pass an Id. To override this behavior, pass another string for the userSecretsId, or include a UserSecretsIdAttribute in your project. To skip all of this and not load any user secrets whatsoever, pass String.Empty.

LoadSettings(string, string, string, Action<Exception>, string, bool)

Declaration
public static CoreConfig.Settings LoadSettings(string appConfigFilename = null, string userSecretsId = null, string configOverrideKey = null, Action<Exception> warningCallback = null, string licenseFileLocation = null, bool disableExtensions = false)
Parameters
string appConfigFilename

string userSecretsId

string configOverrideKey

Action<Exception> warningCallback

string licenseFileLocation

bool disableExtensions

Returns
CoreConfig.Settings