botbuilder-dialogs-adaptive/src/conditions/onUnknownIntent.ts

Rule system for the Microsoft BotBuilder dialog system.

/**
 * @module botbuilder-dialogs-adaptive
 */
/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License.
 */
import { Dialog } from 'botbuilder-dialogs';
import { AdaptiveEvents } from '../adaptiveEvents';
import { OnDialogEvent } from './onDialogEvent';

/**
 * Actions triggered when a UnknownIntent event has been emitted by the recognizer.
 *
 * @remarks
 * A message is considered unhandled if there were no other conditions triggered by the message and
 * there is no active plan being executed.
 * This trigger is run when the utterance is not recognized and the fallback consultation is happening
 * It will only trigger if and when
 *  * it is the leaf dialog AND
 *  * none of the parent dialogs handle the event
 * This provides the parent dialogs the opportunity to handle global commands as fallback interruption.
 */
export class OnUnknownIntent extends OnDialogEvent {
    static $kind = 'Microsoft.OnUnknownIntent';

    /**
     * Creates a new `OnUnknownIntent` instance.
     *
     * @param actions (Optional) The actions to add to the plan when the rule constraints are met.
     * @param condition (Optional) The condition which needs to be met for the actions to be executed.
     */
    constructor(actions: Dialog[] = [], condition?: string) {
        super(AdaptiveEvents.unknownIntent, actions, condition);
    }
}