ChoicePrompt クラス

  • リファレンス
パッケージ:
com.microsoft.bot.dialogs.prompts
Maven 成果物:
com.microsoft.bot:bot-dialogs:4.14.3

public class ChoicePrompt
extends Prompt<FoundChoice>

選択肢の一覧から選択するようにユーザーに求めます。

コンストラクターの概要

コンストラクター 説明
ChoicePrompt(String dialogId)

ChoicePrompt クラスの新しいインスタンスを初期化します。
ChoicePrompt(String dialogId, PromptValidator<FoundChoice> validator, String defaultLocale)

ChoicePrompt クラスの新しいインスタンスを初期化します。
ChoicePrompt(String dialogId, Map<String,ChoiceFactoryOptions> choiceDefaults, PromptValidator<FoundChoice> validator, String defaultLocale)

ChoicePrompt クラスの新しいインスタンスを初期化します。

メソッドの概要

修飾子と型 メソッドと説明
ChoiceFactoryOptions getChoiceOptions()

ChoiceFactory に渡され、ユーザーに表示される選択肢のスタイルを調整するために使用される追加のオプションを取得します。
java.lang.String getDefaultLocale()

プロンプトの言語固有の動作を決定するために使用する既定のロケールを設定または設定します。
FindChoicesOptions getRecognizerOptions()

基になる {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} メソッドに渡される追加のオプションを取得または設定します。
ListStyle getStyle()

ユーザーにプロンプトを表示するときに使用するスタイルを取得します。
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<FoundChoice>> onRecognize(TurnContext turnContext, Map<String,Object> state, PromptOptions options)

ユーザーの入力を認識しようとします。
void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

ChoiceFactory に渡される追加のオプションを設定し、ユーザーに表示される選択肢のスタイルを調整するために使用します。
void setDefaultLocale(String defaultLocale)

プロンプトの言語固有の動作を決定するために使用する既定のロケールを設定します。
void setRecognizerOptions(FindChoicesOptions recognizerOptions)

基になる {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} メソッドに渡される追加のオプションを取得または設定します。
void setStyle(ListStyle style)

ユーザーにプロンプトを表示するときに使用するスタイルを設定します。

メソッドの継承元: 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

コンストラクターの詳細

ChoicePrompt

public ChoicePrompt(String dialogId)

ChoicePrompt クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - このプロンプトに割り当てる ID。

ChoicePrompt

public ChoicePrompt(String dialogId, PromptValidator validator, String defaultLocale)

ChoicePrompt クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - このプロンプトに割り当てる ID。
validator - 省略可能。このプロンプトの追加のカスタム検証を含む {@link PromptValidator{FoundChoice}} です。
defaultLocale - 省略可能。プロンプトの言語固有の動作を決定するために使用される既定のロケール。 ロケールは、言語または言語ファミリを表す 2 文字、3 文字、または 4 文字の ISO 639 コードです。 
                  The value of <xref uid="" data-throw-if-not-resolved="false" data-raw-source="dialogId"></xref> 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. If the <xref uid="com.microsoft.bot.schema.Activity.locale" data-throw-if-not-resolved="false" data-raw-source="Activity#locale"></xref> of
                  the <xref uid="com.microsoft.bot.dialogs.DialogContext" data-throw-if-not-resolved="false" data-raw-source="DialogContext"></xref> .<xref uid="com.microsoft.bot.dialogs.DialogContext.context" data-throw-if-not-resolved="false" data-raw-source="DialogContext#context"></xref>
                  .<xref uid="" data-throw-if-not-resolved="false" data-raw-source="ITurnContext#activity"></xref> is specified, then that
                  local is used to determine language specific behavior;
                  otherwise the <xref uid="" data-throw-if-not-resolved="false" data-raw-source="defaultLocale"></xref> is used. US-English
                  is the used if no language or default locale is
                  available, or if the language or locale is not otherwise
                  supported.

ChoicePrompt

public ChoicePrompt(String dialogId, Map choiceDefaults, PromptValidator validator, String defaultLocale)

ChoicePrompt クラスの新しいインスタンスを初期化します。

パラメーター:

dialogId - このプロンプトに割り当てる ID。
choiceDefaults - Bot Framework SDK でサポートされている_choiceDefaultsのディクショナリをオーバーライドします (プロンプトローカライズ用)。 カスタム選択の既定値を必要とする各 ConfirmPrompt に渡す必要があります。 dialogId の値は、プロンプトが追加される DialogSet または ComponentDialog 内で一意である必要があります。 DialogContext の Activity#locale の場合。DialogContext#context .ITurnContext#activity 指定すると、そのローカルが言語固有の動作を決定するために使用されます。それ以外の場合は、defaultLocale が使用されます。 US-English は、使用できる言語または既定のロケールがない場合、または言語またはロケールがサポートされていない場合に使用されます。
validator - 省略可能。このプロンプトの追加のカスタム検証を含む {@link PromptValidator{FoundChoice}} です。
defaultLocale - 省略可能。プロンプトの言語固有の動作を決定するために使用される既定のロケール。 ロケールは、言語または言語ファミリを表す 2 文字、3 文字、または 4 文字の ISO 639 コードです。

メソッドの詳細

getChoiceOptions

public ChoiceFactoryOptions getChoiceOptions()

ChoiceFactory に渡され、ユーザーに表示される選択肢のスタイルを調整するために使用される追加のオプションを取得します。

戻り値:

選択肢のセットを表示するための追加のオプション。

getDefaultLocale

public String getDefaultLocale()

プロンプトの言語固有の動作を決定するために使用する既定のロケールを設定または設定します。

戻り値:

プロンプトの言語固有の動作を決定するために使用される既定のロケール。

getRecognizerOptions

public FindChoicesOptions getRecognizerOptions()

基になる {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} メソッドに渡される追加のオプションを取得または設定します。

戻り値:

認識戦略を制御するオプション。

getStyle

public ListStyle getStyle()

ユーザーにプロンプトを表示するときに使用するスタイルを取得します。

戻り値:

ユーザーにプロンプトを表示するときに使用するスタイル。

onPrompt

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

ユーザーに入力を求めます。

上書き:

ChoicePrompt.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)

ユーザーの入力を認識しようとします。

上書き:

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

パラメーター:

turnContext - ユーザーとの会話の現在のターンのコンテキスト。
state - ダイアログ スタック上のプロンプトの現在のインスタンスの状態を格納します。
options - プロンプト オプション オブジェクトは、prompt(String dialogId, PromptOptions options) の呼び出しで最初に指定されたオプションから作成されます。

戻り値:

非同期操作を表す CompletableFuture。 タスクが成功した場合、結果には認識の試行の結果が記述されます。

setChoiceOptions

public void setChoiceOptions(ChoiceFactoryOptions choiceOptions)

ChoiceFactory に渡される追加のオプションを設定し、ユーザーに表示される選択肢のスタイルを調整するために使用します。

パラメーター:

choiceOptions - 選択肢のセットを表示するための追加のオプション。

setDefaultLocale

public void setDefaultLocale(String defaultLocale)

プロンプトの言語固有の動作を決定するために使用する既定のロケールを設定します。

パラメーター:

defaultLocale - プロンプトの言語固有の動作を決定するために使用される既定のロケール。

setRecognizerOptions

public void setRecognizerOptions(FindChoicesOptions recognizerOptions)

基になる {@link ChoiceRecognizers#recognizeChoices(String, IList{Choice}, FindChoicesOptions)} メソッドに渡される追加のオプションを取得または設定します。

パラメーター:

recognizerOptions - 認識戦略を制御するオプション。

setStyle

public void setStyle(ListStyle style)

ユーザーにプロンプトを表示するときに使用するスタイルを設定します。

パラメーター:

style - ユーザーにプロンプトを表示するときに使用するスタイル。

適用対象