Edit

Share via

OnQnAMatch class

  • Reference
Package:
botbuilder-dialogs-adaptive

Actions triggered when a MessageUpdateActivity is received.

Extends
OnIntent

Constructors

OnQnAMatch(Dialog[], string)

Initializes a new instance of the OnQnAMatch 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).
entities

Gets or sets entities which must be recognized for this rule to trigger.
event

Gets or sets the event to fire on.
id

Id for condition.
intent

Gets or sets intent to match on.
priority

Get or sets the rule priority expression where 0 is the highest and less than 0 is ignored.
runOnce

A value indicating whether rule should only run once per unique set of memory paths.

Inherited Methods

addExternalCondition(string)

Add external condition to the OnCondition
configure(Record<string, unknown>)

Fluent method for configuring the object.
currentPriority(ActionContext)

Compute the current value of the priority expression and return it.
execute(ActionContext)

Method called to execute the condition's actions.
getConverter(Object)
getDependencies()

Get child dialog dependencies so they can be added to the containers dialogset.
getExpression()

Get the cached expression for this condition.

Constructor Details

OnQnAMatch(Dialog[], string)

Initializes a new instance of the OnQnAMatch class.

new OnQnAMatch(actions?: Dialog[], condition?: string)

Parameters

actions

Dialog[]

Optional. A Dialog list containing the actions to add to the plan when the rule constraints are met.

condition

string

Optional. Condition which needs to be met for the actions to be executed.

Property Details

$kind 

static $kind: string

Property 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: BoolExpression

Property Value

BoolExpression

Inherited From OnCondition.condition

entities

Gets or sets entities which must be recognized for this rule to trigger.

entities: string[]

Property Value

string[]

Inherited From OnIntent.entities

event

Gets or sets the event to fire on.

event: string

Property Value

string

Inherited From OnDialogEvent.event

id

Id for condition.

id: string

Property Value

string

Inherited From OnCondition.id

intent

Gets or sets intent to match on.

intent: string

Property Value

string

Inherited From OnIntent.intent

priority

Get or sets the rule priority expression where 0 is the highest and less than 0 is ignored.

priority: NumberExpression

Property Value

NumberExpression

Inherited From OnCondition.priority

runOnce

A value indicating whether rule should only run once per unique set of memory paths.

runOnce: boolean

Property Value

boolean

Inherited From OnCondition.runOnce

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>): this

Parameters

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): number

Parameters

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 | ConverterFactory

Parameters

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(): Expression

Returns

Expression

Cached expression used to evaluate this condition.

Inherited From OnCondition.getExpression