Class Action
public abstract class Action : PolymorphicObject
- Inheritance
-
Action
- Derived
- Inherited Members
Properties
ActionScope
[YamlIgnore]
public abstract FilterScope ActionScope { get; }
Property Value
DefaultDescription
[YamlIgnore]
public abstract string DefaultDescription { get; }
Property Value
Description
public virtual string? Description { get; set; }
Property Value
FriendlyName
[YamlIgnore]
public virtual string FriendlyName { get; }
Property Value
Identifier
[YamlIgnore]
public virtual Guid Identifier { get; set; }
Property Value
NoEditableSetting
[YamlIgnore]
public bool NoEditableSetting { get; }
Property Value
ScopeId
[YamlIgnore]
public int ScopeId { get; }
Property Value
Suffix
protected override string Suffix { get; }
Property Value
Methods
Alter(ExchangeContext, Exchange?, Connection?, FilterScope, BreakPointManager)
public ValueTask Alter(ExchangeContext context, Exchange? exchange, Connection? connection, FilterScope scope, BreakPointManager breakPointManager)
Parameters
contextExchangeContextexchangeExchangeconnectionConnectionscopeFilterScopebreakPointManagerBreakPointManager
Returns
GetExamples()
public virtual IEnumerable<ActionExample> GetExamples()
Returns
Init(StartupContext)
Called once by the engine to initialize this directive
public virtual void Init(StartupContext startupContext)
Parameters
startupContextStartupContext
InternalAlter(ExchangeContext, Exchange?, Connection?, FilterScope, BreakPointManager)
public abstract ValueTask InternalAlter(ExchangeContext context, Exchange? exchange, Connection? connection, FilterScope scope, BreakPointManager breakPointManager)
Parameters
contextExchangeContextexchangeExchangeconnectionConnectionscopeFilterScopebreakPointManagerBreakPointManager
Returns
IsPremade()
public bool IsPremade()
Returns
Validate(FluxzySetting, Filter)
Check if the action is valid for the given setting and filter
public virtual IEnumerable<ValidationResult> Validate(FluxzySetting setting, Filter filter)
Parameters
settingFluxzySettingfilterFilter
Returns
- IEnumerable<ValidationResult>
A list of validation result items