Sphyrnidae Common Library  2.0.1
Shared Utilities/Library
Sphyrnidae.Common.Variable.VariableSettingsDefault Class Reference

More...

Inheritance diagram for Sphyrnidae.Common.Variable.VariableSettingsDefault:
Sphyrnidae.Common.Variable.VariableSettings Sphyrnidae.Common.Lookup.BaseLookupSetting< VariableSetting > Sphyrnidae.Common.Variable.Interfaces.IVariableSettings Sphyrnidae.Common.Lookup.ILookupSettings< VariableSetting >

Public Member Functions

void Setup ()
 
override Task< IEnumerable< VariableSetting > > GetAll ()
 Retrieves all of the settings at once so that these can be cached locally More...
 
override VariableSetting GetItem (CaseInsensitiveBinaryList< VariableSetting > settingsCollection, string key)
 
override string GetValue (VariableSetting setting)
 
- Public Member Functions inherited from Sphyrnidae.Common.Lookup.BaseLookupSetting< VariableSetting >
virtual T GetItem (CaseInsensitiveBinaryList< T > settingsCollection, string key)
 Retrieves a single setting from the settingsCollection (populated from GetAll) More...
 
virtual string GetValue (T setting)
 Retrieves the value from the setting More...
 
- Public Member Functions inherited from Sphyrnidae.Common.Lookup.ILookupSettings< VariableSetting >
Task< IEnumerable< T > > GetAll ()
 Retrieves all of the settings at once so that these can be cached locally More...
 
GetItem (CaseInsensitiveBinaryList< T > settingsCollection, string key)
 Retrieves a single setting from the settingsCollection (populated from GetAll) More...
 
string GetValue (T setting)
 Retrieves the value from the setting More...
 

Properties

int RecheckSeconds [get]
 
bool EnableRecheck [get]
 
- Properties inherited from Sphyrnidae.Common.Variable.VariableSettings
override string Key = "VariableSettings" [get]
 
override int CachingSeconds [get]
 
- Properties inherited from Sphyrnidae.Common.Lookup.BaseLookupSetting< VariableSetting >
abstract string Key [get]
 
abstract int CachingSeconds [get]
 
- Properties inherited from Sphyrnidae.Common.Lookup.ILookupSettings< VariableSetting >
string Key [get]
 Name of the unique key for this setting (can be sub-divided) More...
 
int CachingSeconds [get]
 How long should the full collection of settings be cached More...
 

Detailed Description

Member Function Documentation

◆ GetAll()

override Task<IEnumerable<VariableSetting> > Sphyrnidae.Common.Variable.VariableSettingsDefault.GetAll ( )
virtual

Retrieves all of the settings at once so that these can be cached locally

Returns
The full collection of settings

Implements Sphyrnidae.Common.Lookup.BaseLookupSetting< VariableSetting >.

◆ GetItem()

override VariableSetting Sphyrnidae.Common.Variable.VariableSettingsDefault.GetItem ( CaseInsensitiveBinaryList< VariableSetting settingsCollection,
string  key 
)

◆ GetValue()

override string Sphyrnidae.Common.Variable.VariableSettingsDefault.GetValue ( VariableSetting  setting)

◆ Setup()

void Sphyrnidae.Common.Variable.VariableSettingsDefault.Setup ( )

Property Documentation

◆ EnableRecheck

bool Sphyrnidae.Common.Variable.VariableSettingsDefault.EnableRecheck
get

◆ RecheckSeconds

int Sphyrnidae.Common.Variable.VariableSettingsDefault.RecheckSeconds
get

The documentation for this class was generated from the following file: