Class ConfigSolution

The configuration information for a solution to be automated.

Inheritance
object
ConfigSolution
Inherited Members
Namespace: CodeFactory.WinVs.Commands
Assembly: CodeFactory.WinVs.dll
Syntax
public class ConfigSolution

Properties

Commands

Configuration of the commands that were loaded.

Declaration
public ImmutableList<ConfigCommand> Commands { get; set; }
Property Value
Type Description
ImmutableList<ConfigCommand>

Name

Name assigned to the configuration that is loaded by the solution.

Declaration
public string Name { get; set; }
Property Value
Type Description
string

Methods

AddCommand(ConfigCommand)

Fluent method that adds a command to the solution configuration.

Declaration
public ConfigSolution AddCommand(ConfigCommand command)
Parameters
Type Name Description
ConfigCommand command

Command to add to the source configuration.
Returns
Type Description
ConfigSolution

Updated solution configuration.

CommandByName(string)

Accesses a target command by the name assigned to the command.

Declaration
public ConfigCommand CommandByName(string name)
Parameters
Type Name Description
string name

The name of the command to retrieve
Returns
Type Description
ConfigCommand

The specific command or null if the command was not found.

CommandsByCategory(string)

Accesses target commands by the category that was assigned to the command.

Declaration
public IReadOnlyList<ConfigCommand> CommandsByCategory(string category)
Parameters
Type Name Description
string category

The category in which the commands where saved as.
Returns
Type Description
IReadOnlyList<ConfigCommand>

The found command sources or an empty list.

CommandsByType(string)

Accesses target commands by the type of command that has been saved.

Declaration
public IReadOnlyList<ConfigCommand> CommandsByType(string commandType)
Parameters
Type Name Description
string commandType

The type of command to retrieve from the configuration.
Returns
Type Description
IReadOnlyList<ConfigCommand>

The found command sources or an empty list.