ActivityPrompt Класс

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

public class ActivityPrompt
extends Dialog

Определяет основное поведение диалогового окна запроса, ожидающего получения действия. Для этого запроса требуется, чтобы проверяющий элемент был передан и полезен при ожидании действий без сообщений, таких как событие. Проверяющий элемент может игнорировать полученные действия до получения ожидаемого типа действия.

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

Конструктор Описание
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)

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

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

Модификатор и тип Метод и описание
java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

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

Вызывается, когда диалоговое окно запроса является активным диалогом, и пользователь ответил на новое действие.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

При переопределении в производном классе пользователю будет предложено ввести данные.
protected java.util.concurrent.CompletableFuture<java.lang.Void> onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

При переопределении в производном классе пользователю будет предложено ввести данные.
protected java.util.concurrent.CompletableFuture<PromptRecognizerResult<Activity>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

При переопределении в производном классе пытается распознать входящие действия.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Вызывается, когда диалоговое окно запроса запрашивается для повторного запроса пользователя на ввод.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, 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

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

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

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

Параметры:

dialogId - Идентификатор, назначаемый этому запросу.
validator - PromptValidator<T>, содержащий проверку для этого запроса. 
              The value of dialogId must be unique within the
              <xref uid="com.microsoft.bot.dialogs.DialogSet" data-throw-if-not-resolved="false" data-raw-source="DialogSet"></xref> or <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="ComponentDialog"></xref> to which the
              prompt is added.

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

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

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

ActivityPrompt.beginDialog(DialogContext dc, Object options)

Параметры:

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

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

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

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

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

ActivityPrompt.continueDialog(DialogContext dc)

Параметры:

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

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

CompletableFuture, представляющий асинхронную операцию. 
     If the task is successful, the result indicates whether the dialog is
     still active after the turn has been processed by the dialog. The
     prompt generally continues to receive the user's replies until it
     accepts the user's reply as valid input for the prompt.

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options)

При переопределении в производном классе пользователю будет предложено ввести данные.

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
state - Содержит состояние текущего экземпляра запроса в стеке диалогов.
options - Объект параметров запроса, созданный из параметров, изначально предоставленных в вызове prompt(String dialogId, PromptOptions options).

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

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

onPrompt

protected CompletableFuture onPrompt(TurnContext turnContext, Map state, PromptOptions options, Boolean isRetry)

При переопределении в производном классе пользователю будет предложено ввести данные.

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
state - Содержит состояние текущего экземпляра запроса в стеке диалогов.
options - Объект параметров запроса, созданный из параметров, изначально предоставленных в вызове prompt(String dialogId, PromptOptions options).
isRetry - Boolean, представляющее, является ли запрос повторным попыткой.

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

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

onRecognize

protected CompletableFuture> onRecognize(TurnContext turnContext, Map state, PromptOptions options)

При переопределении в производном классе пытается распознать входящие действия.

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.
state - Содержит состояние текущего экземпляра запроса в стеке диалогов.
options - Объект параметров запроса, созданный из параметров, изначально предоставленных в вызове prompt(String dialogId, PromptOptions options).

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

CompletableFuture, представляющий асинхронную операцию. 
     If the task is successful, the result describes the result of the
     recognition attempt.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

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

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

ActivityPrompt.repromptDialog(TurnContext turnContext, DialogInstance instance)

Параметры:

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

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

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

resumeDialog

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

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

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

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

Параметры:

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

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

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

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