ParameterService

Default service for getting/setting configuration parameters.

Namespace:
Inetdev.Parameters
Type:
Class
Public:
Yes
Protected:
No
Sealed:
Yes
Abstract:
No
Inherits from:
System.Object
Implements:
Inetdev.Parameters.IParameterService

Constructors

ParameterService

Default constructor

Signature:
public Void ParameterService()

Properties

Provider

Parameter provider.

Signature:
public IParameterProvider Provider { get; set; }

Methods

GetAsync

Gets a parameter.

Signature:
public Task<IParameter> GetAsync(name)
Returns

An IParameter implementation for the parameter.

Parameters
Name Type Summary
name String The name of the parameter to retrive.
Exceptions
Type Summary
MissingRequiredPropertyException Thown when required properties are missing.

GetBooleanAsync

Gets a parameter value as boolean.

Signature:
public Task<Boolean> GetBooleanAsync(name)
Returns

Value of the parameter as boolean.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
Exceptions
Type Summary
MissingRequiredPropertyException Thown when required properties are missing.

GetIntegerAsync

Gets a parameter value as an integer.

Signature:
public Task<Int32> GetIntegerAsync(name)
Returns

Value of the parameter as integer.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
Exceptions
Type Summary
MissingRequiredPropertyException Thown when required properties are missing.

GetStringAsync

Gets a parameter value as a string.

Signature:
public Task<String> GetStringAsync(name)
Returns

Value of the parameter as string.

Parameters
Name Type Summary
name String The name of the parameter to retrive it's value.
Exceptions
Type Summary
MissingRequiredPropertyException Thown when required properties are missing.

SetValueAsync

Sets the value of the parameter.

Signature:
public Task SetValueAsync(name, value)
Parameters
Name Type Summary
name String The name of the parameter to set it's value.
value Object The value to be set.
Exceptions
Type Summary
MissingRequiredPropertyException Thown when required properties are missing.