WaterfallDialog Класс

  • Ссылка
Пакет:
com.microsoft.bot.dialogs
Артефакт Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public class WaterfallDialog
extends Dialog

Диалоговое окно оптимизировано для запроса пользователя с рядом вопросов. Каскады принимают стек функций, которые будут выполняться в последовательности. Каждый каскадный шаг может задать вопрос пользователя, и ответ пользователя будет передан в качестве аргумента на следующий каскадный шаг.

Сводка по конструктору

Конструктор Описание
WaterfallDialog(String dialogId, List<WaterfallStep> actions)

Инициализирует новый экземпляр класса WaterfallDialog.

Сводка по методу

Модификатор и тип Метод и описание
WaterfallDialog addStep(WaterfallStep step)

Добавляет новый шаг в каскад.
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Вызывается при запуске каскадного диалога и отправке в стек диалогов.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Вызывается, когда каскадное диалоговое окно равно _continued_, где он является активным диалогом, а пользователь отвечает с новым действием.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Вызывается, когда диалоговое окно заканчивается.
java.lang.String getVersion()

Возвращает уникальную строку, представляющую версию этого диалогового окна.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> onStep(WaterfallStepContext stepContext)

Вызывается при выполнении отдельного каскадного шага.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Вызывается, когда дочерний каскадный диалог завершил свою очередь, возвращая элемент управления в это диалоговое окно.
protected java.util.concurrent.CompletableFuture<DialogTurnResult> runStep(DialogContext dc, int index, DialogReason reason, Object result)

Вырезает шаг каскадного диалога.

Методы, унаследованные от Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

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

WaterfallDialog

public WaterfallDialog(String dialogId, List actions)

Инициализирует новый экземпляр класса WaterfallDialog.

Параметры:

dialogId - Идентификатор диалогового окна.
actions - Необязательные действия, определенные вызывающим оператором.

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

addStep

public WaterfallDialog addStep(WaterfallStep step)

Добавляет новый шаг в каскад.

Параметры:

step - Шаг добавления.

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

Каскадное диалоговое окно для беглого вызова AddStep().

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

Переопределения:

WaterfallDialog.beginDialog(DialogContext dc, Object options)

Параметры:

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

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

Завершеннаяfuture, представляющая асинхронную операцию. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog.

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

Переопределения:

WaterfallDialog.continueDialog(DialogContext dc)

Параметры:

dc - Тем

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

Завершеннаяfuture, представляющая асинхронную операцию. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     result may also contain a return value.

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

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

Переопределения:

WaterfallDialog.endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Параметры:

turnContext - Контекст для текущей очереди беседы.
instance - Экземпляр текущего диалогового окна.
reason - Причина окончания диалогового окна.

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

Задача, представляющая выполняемую рабочую очередь.

getVersion

public String getVersion()

Возвращает уникальную строку, представляющую версию этого диалогового окна. Если изменение версии между поворотами диалоговой системы приведет к возникновению события DialogChanged.

Переопределения:

WaterfallDialog.getVersion()

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

Версия изменится при изменении количества шагов (так как диалоговое окно не имеет способа оценки содержимого шагов.

onStep

protected CompletableFuture onStep(WaterfallStepContext stepContext)

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

Параметры:

stepContext - Контекст выполнения каскадного шага.

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

Задача, представляющая выполняемую рабочую очередь.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

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

Переопределения:

WaterfallDialog.resumeDialog(DialogContext dc, DialogReason reason, Object result)

Параметры:

dc - Контекст диалогового окна для текущей очереди беседы.
reason - Причина возобновления диалога.
result - Необязательное значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

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

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

runStep

protected CompletableFuture runStep(DialogContext dc, int index, DialogReason reason, Object result)

Вырезает шаг каскадного диалога.

Параметры:

dc - DialogContext для текущего поворота беседы.
index - Индекс текущего каскадного шага для выполнения.
reason - Причина выполнения каскадного шага.
result - Результат, возвращаемый диалогом, который вызывается на предыдущем каскадном шаге.

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

Задача, представляющая выполняемую рабочую очередь.

Применяется к