IConfigParameters

Namespace: Lithnet.Ecma2Framework

Represents a collection of configuration parameters provided by the Synchronization Service

public interface IConfigParameters

Properties

Parameters

Gets the raw configuration parameter dictionary as provided by the synchronization service

public abstract KeyedCollection<string, ConfigParameter> Parameters { get; }

Property Value

KeyedCollection<String, ConfigParameter>

Methods

GetBool(String, Boolean)

Gets a boolean value from the configuration parameter set

bool GetBool(string name, bool defaultValue)

Parameters

name String The name of the configuration parameter

defaultValue Boolean A value to provide if the key is not present or it's value is not present

Returns

Boolean The value of the configuration parameter, or the default value if it doesn't exist

GetInt(String, Int32)

Gets an integer value from the configuration parameter set

int GetInt(string name, int defaultValue)

Parameters

name String The name of the configuration parameter

defaultValue Int32 A value to provide if the key is not present or it's value is not present

Returns

Int32 The value of the configuration parameter, or the default value if it doesn't exist

GetList(String, String)

Gets a list of string values from the configuration parameter set

List<string> GetList(string name, string separator)

Parameters

name String The name of the configuration parameter

separator String The character used a separator between string values

Returns

List<String> The value of the configuration parameter, or the default value if it doesn't exist

GetLong(String, Int64)

Gets a long integer value from the configuration parameter set

long GetLong(string name, long defaultValue)

Parameters

name String The name of the configuration parameter

defaultValue Int64 A value to provide if the key is not present or it's value is not present

Returns

Int64 The value of the configuration parameter, or the default value if it doesn't exist

GetString(String)

Gets a string value from the configuration parameter set

string GetString(string name)

Parameters

name String The name of the configuration parameter

Returns

String THe value of the configuration parameter, or null if the value doesn't exist

GetString(String, String)

Gets a string value from the configuration parameter set

string GetString(string name, string defaultValue)

Parameters

name String The name of the configuration parameter

defaultValue String A value to provide if the key is not present or it's value is not present

Returns

String The value of the configuration parameter, or the default value if it doesn't exist

HasValue(String)

Determines if a configuration parameter exists

bool HasValue(string name)

Parameters

name String The name of the configuration parameter

Returns

Boolean if the parameter is present, if it is not