Class RunStep
Syntax
public abstract class RunStep
Properties
Category
Category name of this RunStep displayed in the searcher menu.
Declaration
public string Category { get; }
Property Value
IsShown
Determine if this RunStep should be displayed in the inspector and searcher menu.
Declaration
public bool IsShown { get; }
Property Value
Name
Declaration
public string Name { get; }
Property Value
Methods
CanRun(BuildConfiguration, out String)
Declaration
public virtual bool CanRun(BuildConfiguration config, out string reason)
Parameters
Returns
Failure(BuildConfiguration, String)
Declaration
public RunStepResult Failure(BuildConfiguration config, string message)
Parameters
Returns
GetCategory(Type)
Get the category name displayed in the searcher menu of a RunStep type.
Declaration
public static string GetCategory(Type type)
Parameters
Returns
GetCategory<T>()
Get the category name displayed in the searcher menu of a RunStep type.
Declaration
public static string GetCategory<T>()
where T : RunStep
Returns
Type Parameters
| Name |
Description |
| T |
The RunStep type.
|
GetIsShown(Type)
Determine if a RunStep type should be displayed in the inspector and searcher menu.
Declaration
public static bool GetIsShown(Type type)
Parameters
Returns
| Type |
Description |
| Boolean |
true if the RunStep is shown, false otherwise.
|
GetIsShown<T>()
Determine if a RunStep type should be displayed in the inspector and searcher menu.
Declaration
public static bool GetIsShown<T>()
where T : RunStep
Returns
| Type |
Description |
| Boolean |
true if the RunStep is shown, false otherwise.
|
Type Parameters
| Name |
Description |
| T |
The RunStep type.
|
GetName(Type)
Declaration
public static string GetName(Type type)
Parameters
Returns
GetName<T>()
Declaration
public static string GetName<T>()
where T : RunStep
Returns
Type Parameters
| Name |
Description |
| T |
The RunStep type.
|
Start(BuildConfiguration)
Declaration
public abstract RunStepResult Start(BuildConfiguration config)
Parameters
Returns
Success(BuildConfiguration, IRunInstance)
Declaration
public RunStepResult Success(BuildConfiguration config, IRunInstance instance)
Parameters
Returns