Class InputQuery

Data class for holding list of input params definition for use in the DebugActionInput

Inheritance

System.Object

InputQuery

Namespace: BennyKok.RuntimeDebug.DebugInput

Assembly: com.bennykok.runtime-debug-action.dll

Syntax

[Serializable]
public class InputQuery

Fields

allParams

Declaration

public List<Param> allParams

Field Value

Type	Description
System.Collections.Generic.List<Param>

Methods

Create()

Create a new instance of InputQuery

Declaration

public static InputQuery Create()

Returns

Type	Description
InputQuery	A new instace of InputQuery

GetParamsDisplay()

Get a string representation of all the params definition

Declaration

public string GetParamsDisplay()

Returns

Type	Description
System.String	Returns a string

Query(String, ParamType)

Add a new param to the param list

Declaration

public InputQuery Query(string name, ParamType type)

Parameters

Type	Name	Description
System.String	name
ParamType	type

Returns

Type	Description
InputQuery

Exceptions

Type	Condition
ParamWithoutDefaultValueException	Thrown when there's no default value for optional param
ParamNameDuplicatedException	Thrown when there's a duplicated param name

Query(String, ParamType, String)

Add a new param to the param list

Declaration

public InputQuery Query(string name, ParamType type, string description)

Parameters

Type	Name	Description
System.String	name
ParamType	type
System.String	description

Returns

Type	Description
InputQuery

Exceptions

Type	Condition
ParamWithoutDefaultValueException	Thrown when there's no default value for optional param
ParamNameDuplicatedException	Thrown when there's a duplicated param name

Query(String, ParamType, String, Func<Object>)

Add a new param to the param list

Declaration

public InputQuery Query(string name, ParamType type, string description, Func<object> valuePrefillCallback)

Parameters

Type	Name	Description
System.String	name
ParamType	type
System.String	description
System.Func<System.Object>	valuePrefillCallback

Returns

Type	Description
InputQuery

Exceptions

Type	Condition
ParamWithoutDefaultValueException	Thrown when there's no default value for optional param
ParamNameDuplicatedException	Thrown when there's a duplicated param name

Query(String, ParamType, String, Object)

Add a new param to the param list

Declaration

public InputQuery Query(string name, ParamType type, string description, object defaultValue)

Parameters

Type	Name	Description
System.String	name
ParamType	type
System.String	description
System.Object	defaultValue

Returns

Type	Description
InputQuery

Exceptions

Type	Condition
ParamWithoutDefaultValueException	Thrown when there's no default value for optional param
ParamNameDuplicatedException	Thrown when there's a duplicated param name

SetParams(List<Param>)

Declaration

public InputQuery SetParams(List<Param> allParams)

Parameters

Type	Name	Description
System.Collections.Generic.List<Param>	allParams

Returns

Type	Description
InputQuery