ChoicePrompt 클래스

  • 참조
패키지:
com.microsoft.bot.dialogs.prompts
Maven 아티팩트:
com.microsoft.bot:bot-dialogs:4.14.3

public class ChoicePrompt
extends Prompt<FoundChoice>

선택 항목 목록에서 선택하라는 메시지를 사용자에게 표시합니다.

생성자 요약

생성자 Description
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 - 사용자에게 프롬프트를 표시할 때 사용할 스타일입니다.

적용 대상