API reference
API reference
Select your platform
No SDKs available
No versions available

IParameterProvider Interface

Resolves parameters for invoking callbacks.

Properties

AllParameterNames : List< string >
[Get]
The list of the names of all parameters in the provider.
Signature
List<string> Meta.Conduit.IParameterProvider.AllParameterNames

Methods

AddCustomType ( name , type )
Add a custom known type (typically enum) to the provider. This should be called BEFORE calling any of the population methods.
Signature
void Meta.Conduit.IParameterProvider.AddCustomType(string name, Type type)
Parameters
name: string  The internal name of the type.
type: Type  The data type.
Returns
void
AddParameter ( parameterName , value )
Explicitly adds a parameter to the provider.
Signature
void Meta.Conduit.IParameterProvider.AddParameter(string parameterName, object value)
Parameters
parameterName: string  The parameter name.
value: object  The parameter value.
Returns
void
ContainsParameter ( parameter , log )
Returns true if a parameter with the specified name can be provided.
Signature
bool Meta.Conduit.IParameterProvider.ContainsParameter(ParameterInfo parameter, StringBuilder log)
Parameters
parameter: ParameterInfo  The name of the parameter.
log: StringBuilder  The log string builder.
Returns
bool  True if a parameter with the specified name can be provided.
GetParameterNamesOfType ( targetType )
Returns a list of parameter names that hold values of the specified type. Note: This is an expensive operation.
Signature
List<string> Meta.Conduit.IParameterProvider.GetParameterNamesOfType(Type targetType)
Parameters
targetType: Type  The type we are querying.
Returns
List< string >  The names of the parameters that match this type.
GetParameterValue ( formalParameter , parameterMap , relaxed )
Provides the actual parameter value matching the supplied formal parameter. Use this overload when you have access to the exact method you want to invoke. This will guarantee a matching type is returned.
Signature
object Meta.Conduit.IParameterProvider.GetParameterValue(ParameterInfo formalParameter, Dictionary< string, string > parameterMap=null, bool relaxed=false)
Parameters
formalParameter: ParameterInfo  The formal parameter.
parameterMap: Dictionary< string, string >  A map from actual parameter names to formal parameter names. Used when parameters have been resolved using type, to identify their mapped names.
relaxed: bool  When true, will match by type when name matching fails.
Returns
object  The actual parameter value matching the formal parameter or null if an error occurs.
GetParameterValue< T > ( parameterName , parameterMap , relaxed )
Provides the actual parameter value matching the supplied parameter.
Signature
T Meta.Conduit.IParameterProvider.GetParameterValue< T >(string parameterName, Dictionary< string, string > parameterMap=null, bool relaxed=false)
Parameters
parameterName: string  The name of the parameter to extract.
parameterMap: Dictionary< string, string >  A map from actual parameter names to formal parameter names. Used when parameters have been resolved using type, to identify their mapped names.
relaxed: bool  When true, will match by type when name matching fails.
Returns
T  The actual parameter value matching the formal parameter or null if an error occurs.
PopulateParametersFromNode ( responseNode )
Populates the parameters from a Wit.Ai response node. Must be called after all parameters have been obtained from Wit.Ai and mapped but before any are read.
Signature
void Meta.Conduit.IParameterProvider.PopulateParametersFromNode(WitResponseNode responseNode)
Parameters
responseNode: WitResponseNode
Returns
void
PopulateRoles ( parameterToRoleMap )
Populates the roles mappings between actual parameters and their roles.. Must be called after all parameters have been populated using PopulateParameters but before any are read.
Signature
void Meta.Conduit.IParameterProvider.PopulateRoles(Dictionary< string, string > parameterToRoleMap)
Parameters
parameterToRoleMap: Dictionary< string, string >  Keys are normalized lowercase internal (code) names. Values are fully qualified parameter names (roles)
Returns
void
SetSpecializedParameter ( reservedParameterName , parameterType )
Registers a certain keyword as reserved for a specialized parameter.
Signature
void Meta.Conduit.IParameterProvider.SetSpecializedParameter(string reservedParameterName, Type parameterType)
Parameters
reservedParameterName: string  The name of the specialized parameter. For example
parameterType: Type  The data type of the parameter
Returns
void