AdaptiveDialog class

Пакет:

botbuilder-dialogs-adaptive

Беседа с адаптивным диалогом моделирует использование событий и событий для динамической адаптации к изменению потока беседы.

Extends

DialogContainer<O>

Конструкторы

AdaptiveDialog(string)

Создает новый экземпляр AdaptiveDialog.

Свойства

$kind
autoEndDialog	Следует ли завершить диалоговое окно при отсутствии действий для выполнения.
conditionTracker
defaultResultProperty	Свойство, возвращаемое в качестве результата, когда диалоговое окно заканчивается, когда нет дополнительных действий и AutoEndDialog = true.
generator	Необязательный. Переопределение генератора языков.
recognizer	Необязательный. Распознаватель, используемый для анализа речевых фрагментов сообщений.
schema	Задает схему JSON для диалогового окна. Возвращает схему JSON для диалогового окна.
selector	Необязательный. Селектор для выбора возможных событий для выполнения.
triggers	Обработчики триггеров реагируют на условия, изменяющие план выполнения.

Унаследованные свойства

dialogs	Набор диалоговых окон контейнеров.
EndOfTurn	Возвращает результат конца по умолчанию.
id
telemetryClient

Методы

beginDialog(DialogContext, O)	Вызывается при запуске диалогового окна и отправке в стек диалогов.
continueDialog(DialogContext)	Вызывается, когда диалоговое окно продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.
createChildContext(DialogContext)	Создает дочерний DialogContext для заданного контекста.
endDialog(TurnContext, DialogInstance, DialogReason)	Вызывается, когда диалоговое окно заканчивается.
getConverter(Object)
getDependencies()	Возвращает диалоговых перечисленных зависимостей.
repromptDialog(DialogContext | TurnContext, DialogInstance)	Повторная подготовка пользователя.
resumeDialog(DialogContext, DialogReason, any)	Вызывается, когда дочернее диалоговое окно завершило свою очередь, возвращая элемент управления в это диалоговое окно.

Наследуемые методы

configure(Record<string, unknown>)	Метод Fluent для настройки объекта.
findDialog(string)	Находит дочернее диалоговое окно, которое ранее было добавлено в контейнер.
getVersion()	Кодированная строка, используемая для обнаружения изменений бота при повторном развертывании.
onDialogEvent(DialogContext, DialogEvent)	Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.

Сведения о конструкторе

AdaptiveDialog(string)

Создает новый экземпляр AdaptiveDialog.

new AdaptiveDialog(dialogId?: string)

Параметры

dialogId

string

(Необязательно) уникальный идентификатор компонента в наборе диалоговых окон родителей.

Сведения о свойстве

$kind

static $kind: string

Значение свойства

string

autoEndDialog

Следует ли завершить диалоговое окно при отсутствии действий для выполнения.

autoEndDialog: BoolExpression

Значение свойства

BoolExpression

Комментарии

Если задано значение true, при отсутствии действий текущее диалоговое окно завершится. Если значение false, при отсутствии действий, текущее диалоговое окно просто завершит поворот и по-прежнему будет активным. По умолчанию значение true.

conditionTracker

static conditionTracker: string

Значение свойства

string

defaultResultProperty

Свойство, возвращаемое в качестве результата, когда диалоговое окно заканчивается, когда нет дополнительных действий и AutoEndDialog = true.

defaultResultProperty: string

Значение свойства

string

Комментарии

По умолчанию используется значение dialog.result.

generator

Необязательный. Переопределение генератора языков.

generator?: LanguageGenerator

Значение свойства

LanguageGenerator

recognizer

Необязательный. Распознаватель, используемый для анализа речевых фрагментов сообщений.

recognizer?: Recognizer

Значение свойства

Recognizer

schema

Задает схему JSON для диалогового окна. Возвращает схему JSON для диалогового окна.

object schema

Значение свойства

object

Схема диалога.

selector

Необязательный. Селектор для выбора возможных событий для выполнения.

selector: TriggerSelector

Значение свойства

TriggerSelector

triggers

Обработчики триггеров реагируют на условия, изменяющие план выполнения.

triggers: OnCondition[]

Значение свойства

OnCondition[]

Сведения об унаследованном свойстве

dialogs

Набор диалоговых окон контейнеров.

dialogs: DialogSet

Значение свойства

DialogSet

наследуется от диалогового окна dialogContainer.dialogs

EndOfTurn

Возвращает результат конца по умолчанию.

static EndOfTurn: DialogTurnResult

Значение свойства

DialogTurnResult

Комментарии

Этот результат указывает, что диалоговое окно (или логический шаг в диалоговом окне) завершило обработку текущего шага, по-прежнему активно и ожидает дополнительных входных данных.

унаследован от диалогового окна.EndOfTurn

id

id: string

Значение свойства

string

унаследован от Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

Значение свойства

BotTelemetryClient

Унаследовано от DialogContainer.telemetryClient

Сведения о методе

beginDialog(DialogContext, O)

Вызывается при запуске диалогового окна и отправке в стек диалогов.

function beginDialog(dc: DialogContext, options?: O): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

options

O

Необязательные, начальные сведения для передачи в диалоговое окно.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание, представляющее асинхронную операцию.

continueDialog(DialogContext)

Вызывается, когда диалоговое окно продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание, представляющее асинхронную операцию.

createChildContext(DialogContext)

Создает дочерний DialogContext для заданного контекста.

function createChildContext(dc: DialogContext): DialogContext

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

Возвращаемое значение

DialogContext

Дочерний DialogContext или null, если для данного контекста не найдено AdaptiveDialogState.actions.

endDialog(TurnContext, DialogInstance, DialogReason)

Вызывается, когда диалоговое окно заканчивается.

function endDialog(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

Параметры

turnContext

TurnContext

Объект контекста для этого поворота.

instance

DialogInstance

Сведения о состоянии, связанные с экземпляром этого диалогового окна в стеке диалогов.

reason

DialogReason

Причина, по которой диалоговое окно закончилось.

Возвращаемое значение

Promise<void>

Обещание, представляющее асинхронную операцию.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property

Object

Ключ конфигурации условного селектора.

Возвращаемое значение

Converter | ConverterFactory

Преобразователь конфигурации селектора.

getDependencies()

Возвращает диалоговых перечисленных зависимостей.

function getDependencies(): Dialog[]

Возвращаемое значение

Dialog[]

(xref:botbuilder-dialogs. Перечисление зависимостей диалогового окна.

repromptDialog(DialogContext | TurnContext, DialogInstance)

Повторная подготовка пользователя.

function repromptDialog(context: DialogContext | TurnContext, instance: DialogInstance): Promise<void>

Параметры

context

DialogContext | TurnContext

Объект контекста для поворота.

instance

DialogInstance

Текущие сведения о состоянии для этого диалогового окна.

Возвращаемое значение

Promise<void>

Обещание, представляющее асинхронную операцию.

resumeDialog(DialogContext, DialogReason, any)

Вызывается, когда дочернее диалоговое окно завершило свою очередь, возвращая элемент управления в это диалоговое окно.

function resumeDialog(dc: DialogContext, _reason?: DialogReason, _result?: any): Promise<DialogTurnResult>

Параметры

dc

DialogContext

Контекст диалогового окна для текущей очереди беседы.

_reason

DialogReason

Причина возобновления диалога.

_result

any

Необязательное значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

Возвращаемое значение

Promise<DialogTurnResult>

Обещание, представляющее асинхронную операцию.

Сведения о наследуемом методе

configure(Record<string, unknown>)

Метод Fluent для настройки объекта.

function configure(config: Record<string, unknown>): this

Параметры

config

Record<string, unknown>

Параметры конфигурации для применения.

Возвращаемое значение

this

После завершения операции настраиваемый.

наследуется от Configurable.configure

findDialog(string)

Находит дочернее диалоговое окно, которое ранее было добавлено в контейнер.

function findDialog(dialogId: string): Dialog | undefined

Параметры

dialogId

string

Идентификатор диалогового окна для поиска.

Возвращаемое значение

Dialog | undefined

При обнаружении диалогового окна; в противном случае значение NULL.

унаследован от диалогового окна DialogContainer.findDialog

getVersion()

Кодированная строка, используемая для обнаружения изменений бота при повторном развертывании.

function getVersion(): string

Возвращаемое значение

string

Уникальная строка, которая должна изменяться только при изменении диалогового окна таким образом, чтобы перезапустить диалоговое окно.

Комментарии

По умолчанию возвращается диалоговое окно идентификатор, но его можно переопределить, чтобы обеспечить более точную логику обнаружения изменений. Любое диалоговое окно в стеке с изменением версии приведет к возникновению события versionChanged. Если это событие не обрабатывается ботом, возникает ошибка, в результате чего выполняется логика обработчика ошибок ботов.

Возврат пустой строки отключит отслеживание версий для компонента вместе.

унаследован от Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Параметры

dc

DialogContext

Контекст диалогового окна для текущей очереди беседы.

e

DialogEvent

Возникает событие.

Возвращаемое значение

Promise<boolean>

Значение True, если событие обрабатывается текущим диалогом, а пузырьк должен остановиться.

унаследовано от диалогового окна DialogContainer.onDialogEvent