Interface IParameterFactory

An interface for constructing Phoenix.Views.Parameters.IParameter from brain parameters.

Namespace: Phoenix.BotBrain.Parameters
Assembly: Phoenix.Plugin.BotBrain.Parameters.dll
Syntax
public interface IParameterFactory

Methods

View Source

Create(ParameterMetadata, string, string, IParameterManager, bool)

Creates the parameter object for a given parameter.

Declaration
IParameter Create(ParameterMetadata metadata, string name, string fullName, IParameterManager parameters, bool setDefaultValue = true)
Parameters
Type Name Description
ParameterMetadata metadata

The parameter metadata.
string name

The parameter name.
string fullName

The fully qualified parameter name.
IParameterManager parameters

The parameter manager.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Returns
Type Description
IParameter

The parameter object.
View Source

Create(string[], IParameterManager, bool)

Creates the parameter object for a given parameter.

Declaration
IParameter Create(string[] names, IParameterManager parameters, bool setDefaultValue = true)
Parameters
Type Name Description
string[] names

The possible parameter names.
IParameterManager parameters

The parameter manager.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Returns
Type Description
IParameter

The parameter object.
View Source

CreateEditable(ParameterMetadata, string, string, string, IParameterManager, bool, Action?)

Creates the editable parameter object for a given parameter.

Declaration
IParameter CreateEditable(ParameterMetadata metadata, string name, string fullName, string desiredName, IParameterManager parameters, bool setDefaultValue = true, Action? onValueChanged = null)
Parameters
Type Name Description
ParameterMetadata metadata

The parameter metadata.
string name

The parameter's short name.
string fullName

The qualified parameter name used to retrieve the initial value.
string desiredName

The qualified parameter name used to set its value.
IParameterManager parameters

The parameter manager.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Action onValueChanged

An optional callback for when the value is changed.
Returns
Type Description
IParameter

The parameter object.
View Source

CreateEditable(string[], IParameterManager, bool, Action?)

Creates the editable parameter object for a given parameter.

Declaration
IParameter CreateEditable(string[] names, IParameterManager parameters, bool setDefaultValue = true, Action? onValueChanged = null)
Parameters
Type Name Description
string[] names

The parameter names.
IParameterManager parameters

The parameter manager.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Action onValueChanged

An optional callback for when the value is changed.
Returns
Type Description
IParameter

The parameter object.
View Source

CreateWithValue(ParameterMetadata, string, object, bool)

Creates the parameter object with an initial value for a given parameter.

Declaration
IParameter CreateWithValue(ParameterMetadata metadata, string name, object value, bool setDefaultValue = true)
Parameters
Type Name Description
ParameterMetadata metadata

The parameter metadata.
string name

The parameter name.
object value

The parameter value.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Returns
Type Description
IParameter

The parameter object.
View Source

CreateWithValue(string, object, bool)

Creates the parameter object with an initial value for a given parameter.

Declaration
IParameter CreateWithValue(string name, object value, bool setDefaultValue = true)
Parameters
Type Name Description
string name

The parameter name.
object value

The parameter value.
bool setDefaultValue

Whether or not to set a default value for null parameters.
Returns
Type Description
IParameter

The parameter object.

Extension Methods