Prompt<T> Класс

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

Параметры типа

T

Введите запрос для.

public abstract class Prompt
extends Dialog

Определяет основное поведение диалоговых окон запроса. Когда запрос заканчивается, он должен возвращать объект, представляющий значение, которое было предложено. Используйте add(Dialog dialog) или addDialog(Dialog dialog), чтобы добавить запрос в диалоговый набор или диалоговое окно компонента соответственно. Чтобы запустить запрос, используйте prompt(String dialogId, PromptOptions options) или beginDialog(String dialogId, Object options). Если вы запускаете запрос из WaterfallStep в WaterfallDialog, результат запроса будет доступен на следующем шаге каскада.

Сводка по полю

Модификатор и тип Поле и описание
static final java.lang.String ATTEMPTCOUNTKEY

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

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

Инициализирует новый экземпляр класса {@link Prompt{T}}.

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

Модификатор и тип Метод и описание
protected Activity appendChoices(Activity prompt, String channelId, List<Choice> choices, ListStyle style, ChoiceFactoryOptions options)

При переопределении в производном классе добавляет варианты действия, когда пользователю будет предложено ввести данные.
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.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

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

При переопределении в производном классе пользователю будет предложено ввести данные.
protected abstract java.util.concurrent.CompletableFuture<PromptRecognizerResult<T>> 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

Сведения о полях

ATTEMPTCOUNTKEY

public static final String ATTEMPTCOUNTKEY

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

Prompt

public Prompt(String dialogId, PromptValidator validator)

Инициализирует новый экземпляр класса {@link Prompt{T}}. Вызывается из конструкторов в производных классах для инициализации класса {@link Prompt{T}}.

Параметры:

dialogId - Идентификатор, назначаемый этому запросу.
validator - Необязательно, {@link 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="com.microsoft.bot.dialogs.DialogSet"></xref> or
              <xref uid="com.microsoft.bot.dialogs.ComponentDialog" data-throw-if-not-resolved="false" data-raw-source="com.microsoft.bot.dialogs.ComponentDialog"></xref> to which
              the prompt is added.

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

appendChoices

protected Activity appendChoices(Activity prompt, String channelId, List choices, ListStyle style, ChoiceFactoryOptions options)

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

Параметры:

prompt - Действие, к которое нужно добавить выбранные варианты.
channelId - Идентификатор канала пользователя.
choices - Варианты добавления.
style - Указывает, как следует представить варианты пользователю.
options - Параметры форматирования, используемые при представлении вариантов.

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

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

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

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

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

Prompt<T>.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)

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

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

Prompt<T>.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.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

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

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

Prompt<T>.onPreBubbleEvent(DialogContext dc, DialogEvent e)

Параметры:

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

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

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

onPrompt

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

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

Параметры:

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

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

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

onRecognize

protected abstract 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)

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

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

Prompt<T>.repromptDialog(TurnContext turnContext, DialogInstance instance)

Параметры:

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

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

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

resumeDialog

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

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

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

Prompt<T>.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.

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