TextPrompt 類別

  • 參考
套件:
com.microsoft.bot.dialogs.prompts
Maven 成品:
com.microsoft.bot:bot-dialogs:4.14.3

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

提示使用者輸入文字。

建構函式摘要

建構函式 Description
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。 如果工作成功，結果會描述辨識嘗試的結果。

適用於