TextPrompt Класс

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

public class TextPrompt
extends Prompt<java.lang.String>

Запрашивает у пользователя ввод текста.

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

Конструктор Описание
TextPrompt(String dialogId)

Инициализирует новый экземпляр класса TextPrompt.
TextPrompt(String dialogId, PromptValidator<String> validator)

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

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

Модификатор и тип Метод и описание
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Вызывается перед тем, как событие будет перемыкаться в родительский объект.
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<java.lang.String>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Пытается распознать входные данные пользователя.

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

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

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

appendChoices beginDialog continueDialog onPreBubbleEvent onPrompt onRecognize repromptDialog resumeDialog

Методы, унаследованные от 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

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

TextPrompt

public TextPrompt(String dialogId)

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

Параметры:

dialogId - Идентификатор, назначаемый этому запросу. Значение dialogId должно быть уникальным в пределах DialogSet или ComponentDialog, к которому добавляется запрос.

TextPrompt

public TextPrompt(String dialogId, PromptValidator validator)

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

Параметры:

dialogId - Идентификатор, назначаемый этому запросу.
validator - Необязательно, {@link PromptValidator{FoundChoice}}, содержащий дополнительную настраиваемую проверку для этого запроса. Значение dialogId должно быть уникальным в пределах DialogSet или ComponentDialog, к которому добавляется запрос.

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

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

Вызывается перед тем, как событие будет перемыкаться в родительский объект. Это хорошее место для перехвата события, так как возврат "true" предотвратит дальнейшее перебои события в диалоговых окнах, а также предотвратит выполнение любых дочерних диалогов при обработке по умолчанию.

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

TextPrompt.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Параметры:

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

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

Должно ли событие обрабатываться текущим диалогом и дальнейшей обработкой.

onPrompt

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

Запрашивает пользователю входные данные.

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

TextPrompt.onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options, Boolean isRetry)

Параметры:

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

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

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

onRecognize

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

Пытается распознать входные данные пользователя.

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

TextPrompt.onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

Параметры:

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

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

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

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