OnCommandResultActivity class
Actions triggered when a CommandResult activity is received.
- Extends
Constructors
| On |
Intiializes a new instance of the OnCommandResultActivity class. |
Properties
| $kind |
Inherited Properties
| actions | Gets or sets the actions to add to the plan when the rule constraints are met. |
| condition | Gets or sets the condition which needs to be met for the actions to be executed (OPTIONAL). |
| event | Gets or sets the event to fire on. |
| id | Id for condition. |
| priority | Get or sets the rule priority expression where 0 is the highest and less than 0 is ignored. |
| run |
A value indicating whether rule should only run once per unique set of memory paths. |
| type | Gets or sets the ActivityType which must be matched for this to trigger. |
Inherited Methods
| add |
Add external condition to the OnCondition |
| configure(Record<string, unknown>) | Fluent method for configuring the object. |
| current |
Compute the current value of the priority expression and return it. |
| execute(Action |
Method called to execute the condition's actions. |
| get |
|
| get |
Get child dialog dependencies so they can be added to the containers dialogset. |
| get |
Get the cached expression for this condition. |
Constructor Details
OnCommandResultActivity(Dialog[], string)
Intiializes a new instance of the OnCommandResultActivity class.
new OnCommandResultActivity(actions?: Dialog[], condition?: string)Parameters
- actions
-
Dialog[]
Optional, list of actions.
- condition
-
string
Optional, condition which needs to be met for the actions to be executed.
Property Details
$kind
static $kind: stringProperty Value
string
Inherited Property Details
actions
Gets or sets the actions to add to the plan when the rule constraints are met.
actions: Dialog[]Property Value
Dialog[]
Inherited From OnCondition.actions
condition
Gets or sets the condition which needs to be met for the actions to be executed (OPTIONAL).
condition: BoolExpressionProperty Value
BoolExpression
Inherited From OnCondition.condition
event
Gets or sets the event to fire on.
event: stringProperty Value
string
Inherited From OnDialogEvent.event
id
priority
Get or sets the rule priority expression where 0 is the highest and less than 0 is ignored.
priority: NumberExpressionProperty Value
NumberExpression
Inherited From OnCondition.priority
runOnce
A value indicating whether rule should only run once per unique set of memory paths.
runOnce: booleanProperty Value
boolean
Inherited From OnCondition.runOnce
type
Gets or sets the ActivityType which must be matched for this to trigger.
type: stringProperty Value
string
Inherited From OnActivity.type
Inherited Method Details
addExternalCondition(string)
Add external condition to the OnCondition
function addExternalCondition(condition: string)Parameters
- condition
-
string
External constraint to add, it will be AND'ed to all other constraints.
Inherited From OnCondition.addExternalCondition
configure(Record<string, unknown>)
Fluent method for configuring the object.
function configure(config: Record<string, unknown>): thisParameters
- config
-
Record<string, unknown>
Configuration settings to apply.
Returns
this
The Configurable after the operation is complete.
Inherited From Configurable.configure
currentPriority(ActionContext)
Compute the current value of the priority expression and return it.
function currentPriority(actionContext: ActionContext): numberParameters
- actionContext
- ActionContext
Context to use for evaluation.
Returns
number
Computed priority.
Inherited From OnCondition.currentPriority
execute(ActionContext)
Method called to execute the condition's actions.
function execute(actionContext: ActionContext): Promise<ActionChangeList[]>Parameters
- actionContext
- ActionContext
Context.
Returns
Promise<ActionChangeList[]>
A promise with plan change list.
Inherited From OnCondition.execute
getConverter(Object)
function getConverter(property: Object): Converter | ConverterFactoryParameters
- property
-
Object
The key of the conditional selector configuration.
Returns
Converter | ConverterFactory
The converter for the selector configuration.
Inherited From OnCondition.getConverter
getDependencies()
Get child dialog dependencies so they can be added to the containers dialogset.
function getDependencies(): Dialog[]Returns
Dialog[]
A list of Dialog.
Inherited From OnCondition.getDependencies
getExpression()
Get the cached expression for this condition.
function getExpression(): ExpressionReturns
Expression
Cached expression used to evaluate this condition.
Inherited From OnCondition.getExpression