ActivityPrompt 클래스

패키지:

com.microsoft.bot.dialogs.prompts

Maven 아티팩트:

com.microsoft.bot:bot-dialogs:4.14.3

• java.lang.Object
• • com.microsoft.bot.dialogs.Dialog
  • • com.microsoft.bot.dialogs.prompts.ActivityPrompt

public class ActivityPrompt
extends Dialog

활동이 수신될 때까지 대기하는 프롬프트 대화 상자의 핵심 동작을 정의합니다. 이 프롬프트는 유효성 검사기를 전달해야 하며 이벤트와 같은 비 메시지 활동을 수신할 때까지 대기할 때 유용합니다. 유효성 검사기는 예상된 활동 형식이 수신될 때까지 수신된 활동을 무시할 수 있습니다.

생성자 요약

생성자	Description
ActivityPrompt(String dialogId, PromptValidator<Activity> validator)	ActivityPrompt 클래스의 새 인스턴스를 초기화합니다.

메서드 요약

한정자 및 형식	메서드 및 설명
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.Void>	onPrompt(TurnContext turnContext, Map<String,Object> state, PromptOptions options) 파생 클래스에서 재정의된 경우 사용자에게 입력을 묻는 메시지를 표시합니다.
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<Activity>>	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

생성자 세부 정보

ActivityPrompt

public ActivityPrompt(String dialogId, PromptValidator validator)

ActivityPrompt 클래스의 새 인스턴스를 초기화합니다. ActivityPrompt 클래스를 초기화하기 위해 파생 클래스의 생성자에서 호출됩니다.

매개 변수:

dialogId - 이 프롬프트에 할당할 ID입니다.

validator - 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="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.

메서드 세부 정보

beginDialog

public CompletableFuture beginDialog(DialogContext dc, Object options)

프롬프트 대화 상자가 대화 스택에 푸시되고 활성화될 때 호출됩니다.

재정의:

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

프롬프트 대화 상자가 활성 대화이고 사용자가 새 활동으로 응답할 때 호출됩니다.

재정의:

ActivityPrompt.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.

onPrompt

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

파생 클래스에서 재정의된 경우 사용자에게 입력을 묻는 메시지를 표시합니다.

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

state - 대화 상자 스택에서 프롬프트의 현재 인스턴스에 대한 상태를 포함합니다.

options - 프롬프트 옵션 개체는 에 대한 호출 prompt(String dialogId, PromptOptions options) 에서 처음 제공된 옵션에서 생성됩니다.

반환:

비동기 작업을 나타내는 CompletableFuture입니다.

onPrompt

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

파생 클래스에서 재정의된 경우 사용자에게 입력을 묻는 메시지를 표시합니다.

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

state - 대화 상자 스택에서 프롬프트의 현재 인스턴스에 대한 상태를 포함합니다.

options - 프롬프트 옵션 개체는 에 대한 호출 prompt(String dialogId, PromptOptions options) 에서 처음 제공된 옵션에서 생성됩니다.

isRetry - Boolean 프롬프트가 재시도인지를 나타내는 입니다.

반환:

CompletableFuture 비동기 작업의 결과를 나타내는 입니다.

onRecognize

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

사용자에게 입력을 다시 요청하는 프롬프트 대화 상자가 요청되었을 때 호출됩니다.

재정의:

ActivityPrompt.repromptDialog(TurnContext turnContext, DialogInstance instance)

매개 변수:

turnContext - 사용자와의 현재 대화 전환에 대한 컨텍스트입니다.

instance - 스택에 있는 대화 상자의 인스턴스입니다.

반환:

비동기 작업을 나타내는 CompletableFuture입니다.

resumeDialog

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

스택의 이전 활성 대화 상자가 완료되는 경우와 같이 대화 상자 스택의 활성 대화가 다시 시작될 때 호출됩니다.

재정의:

ActivityPrompt.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.