DateTimePrompt class

패키지:

botbuilder-dialogs

날짜/시간 식을 입력하라는 메시지를 사용자에게 표시합니다.

Extends

Prompt<DateTimeResolution[]>

설명

기본적으로 프롬프트는 DateTimeResolution[]호출 대화 상자로 돌아갑니다.

생성자

DateTimePrompt(string, PromptValidator<DateTimeResolution[]>, string)

새 DateTimePrompt 인스턴스를 만듭니다.

속성

defaultLocale	인식해야 하는 프롬프트 기본 로캘입니다.
id	대화 상자의 고유 ID입니다. 대화 상자의 고유 ID를 설정합니다.
telemetryClient	이 대화 상자의 원격 분석 클라이언트를 가져옵니다. 이 대화 상자의 원격 분석 클라이언트를 설정합니다.

상속된 속성

EndOfTurn

기본 턴 종료 결과를 가져옵니다.

상속된 메서드

beginDialog(DialogContext, PromptOptions)	프롬프트 대화 상자가 대화 스택으로 푸시되고 활성화될 때 호출됩니다.
configure(Record<string, unknown>)	개체를 구성하기 위한 Fluent 메서드입니다.
continueDialog(DialogContext)	프롬프트 대화 상자가 활성 대화이고 사용자가 새 활동으로 회신할 때 호출됩니다.
endDialog(TurnContext, DialogInstance, DialogReason)	파생 클래스에서 재정의된 경우 종료되기 전에 대화 상자에 대한 정리를 수행합니다.
getConverter(string)
getVersion()	다시 배포할 때 봇 변경 내용을 검색하는 데 사용되는 인코딩된 문자열입니다.
onDialogEvent(DialogContext, DialogEvent)	현재 대화 상자 또는 현재 대화 상자가 시작된 대화 상자에서 DialogContext.emitEvent()사용하여 이벤트가 발생할 때 호출됩니다.
repromptDialog(TurnContext, DialogInstance)	사용자에게 입력을 다시 요청하는 프롬프트 대화 상자가 요청되었을 때 호출됩니다.
resumeDialog(DialogContext, DialogReason, any)	프롬프트 대화 상자가 스택의 이전 활성 대화 상자가 완료되는 경우와 같이 대화 상자 스택의 활성 대화가 될 때 호출됩니다.

생성자 세부 정보

DateTimePrompt(string, PromptValidator<DateTimeResolution[]>, string)

새 DateTimePrompt 인스턴스를 만듭니다.

new DateTimePrompt(dialogId: string, validator?: PromptValidator<DateTimeResolution[]>, defaultLocale?: string)

매개 변수

dialogId

string

부모 DialogSet 또는 ComponentDialog내 대화 상자의 고유 ID입니다.

validator

PromptValidator<DateTimeResolution[]>

(선택 사항) 사용자가 프롬프트에 응답할 때마다 호출되는 유효성 검사기입니다.

defaultLocale

string

(선택 사항) TurnContext.activity.locale 지정되지 않은 경우 사용할 로캘입니다. 기본값은 en-us.

속성 세부 정보

defaultLocale

인식해야 하는 프롬프트 기본 로캘입니다.

defaultLocale: string | undefined

속성 값

string | undefined

id

대화 상자의 고유 ID입니다. 대화 상자의 고유 ID를 설정합니다.

string id

속성 값

string

대화 상자의 ID입니다.

설명

지정하지 않으면 자동으로 생성됩니다.

telemetryClient

이 대화 상자의 원격 분석 클라이언트를 가져옵니다. 이 대화 상자의 원격 분석 클라이언트를 설정합니다.

BotTelemetryClient telemetryClient

속성 값

BotTelemetryClient

BotTelemetryClient는 로깅에 사용할.

상속된 속성 세부 정보

EndOfTurn

기본 턴 종료 결과를 가져옵니다.

static EndOfTurn: DialogTurnResult

속성 값

DialogTurnResult

설명

이 결과는 대화 상자(또는 대화 상자 내의 논리적 단계)가 현재 턴에 대한 처리를 완료했으며 여전히 활성 상태이며 더 많은 입력을 기다리고 있음을 나타냅니다.

dialog.EndOfTurn 상속된

상속된 메서드 세부 정보

beginDialog(DialogContext, PromptOptions)

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

function beginDialog(dc: DialogContext, options: PromptOptions): Promise<DialogTurnResult>

매개 변수

dc

DialogContext

DialogContext는 대화의 현재 순서에 대한.

options

PromptOptions

선택적. promptOptions시작 중인 프롬프트에 전달할 추가 정보입니다.

반환

Promise<DialogTurnResult>

비동기 작업을 나타내는 Promise.

설명

작업이 성공하면 프롬프트가 턴을 처리한 후에도 프롬프트가 여전히 활성 상태인지 여부를 나타냅니다.

Prompt.beginDialog 상속된

configure(Record<string, unknown>)

개체를 구성하기 위한 Fluent 메서드입니다.

function configure(config: Record<string, unknown>): this

매개 변수

config

Record<string, unknown>

적용할 구성 설정입니다.

반환

this

작업이 완료된 후 구성 가능한.

Configurable.configure 상속된

continueDialog(DialogContext)

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

function continueDialog(dc: DialogContext): Promise<DialogTurnResult>

매개 변수

dc

DialogContext

현재 대화 전환에 대한 DialogContext.

반환

Promise<DialogTurnResult>

비동기 작업을 나타내는 Promise.

설명

작업이 성공하면 결과는 대화 상자에서 턴이 처리된 후에도 대화 상자가 여전히 활성 상태인지 여부를 나타냅니다. 프롬프트는 일반적으로 사용자의 회신을 프롬프트에 대한 유효한 입력으로 수락할 때까지 사용자의 회신을 계속 받습니다.

Prompt.continueDialog 상속된

endDialog(TurnContext, DialogInstance, DialogReason)

파생 클래스에서 재정의된 경우 종료되기 전에 대화 상자에 대한 정리를 수행합니다.

function endDialog(_context: TurnContext, _instance: DialogInstance, _reason: DialogReason): Promise<void>

매개 변수

_context

TurnContext

순서에 대한 컨텍스트 개체입니다.

_instance

DialogInstance

이 대화 상자의 현재 상태 정보입니다.

_reason

DialogReason

대화 상자가 끝나는 이유입니다.

반환

Promise<void>

설명

종료하기 전에 로깅 또는 정리를 수행해야 하는 파생 대화 상자는 이 메서드를 재정의해야 합니다. 기본적으로 이 메서드는 효과가 없습니다.

DialogContext 현재 대화가 종료되면 이 메서드를 호출합니다.

참조

• dialogContext.cancelAllDialogs
• DialogContext.endDialog
• dialogContext.replaceDialog

Dialog.endDialog 상속된

getConverter(string)

function getConverter(_property: string): Converter | ConverterFactory

매개 변수

_property

string

조건부 선택기 구성의 키입니다.

반환

Converter | ConverterFactory

선택기 구성의 변환기입니다.

Configurable.getConverter 상속된

getVersion()

다시 배포할 때 봇 변경 내용을 검색하는 데 사용되는 인코딩된 문자열입니다.

function getVersion(): string

반환

string

대화 상자를 다시 시작해야 하는 방식으로 대화 상자가 변경된 경우에만 변경해야 하는 고유 문자열입니다.

설명

기본적으로 id 대화 상자를 반환하지만 보다 정확한 변경 검색 논리를 제공하도록 재정의할 수 있습니다. 스택의 버전이 변경된 대화 상자는 versionChanged 이벤트가 발생합니다. 이 이벤트가 봇에서 처리되지 않으면 오류가 throw되어 봇 오류 처리기 논리가 실행됩니다.

빈 문자열을 반환하면 구성 요소에 대한 버전 추적이 모두 함께 사용하지 않도록 설정됩니다.

Dialog.getVersion 상속된

onDialogEvent(DialogContext, DialogEvent)

현재 대화 상자 또는 현재 대화 상자가 시작된 대화 상자에서 DialogContext.emitEvent()사용하여 이벤트가 발생할 때 호출됩니다.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

매개 변수

dc

DialogContext

현재 대화 전환에 대한 대화 컨텍스트입니다.

e

DialogEvent

발생 중인 이벤트입니다.

반환

Promise<boolean>

True이면 현재 대화 상자에서 이벤트를 처리하고 버블링을 중지해야 합니다.

Dialog.onDialogEvent 상속된

repromptDialog(TurnContext, DialogInstance)

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

function repromptDialog(context: TurnContext, instance: DialogInstance): Promise<void>

매개 변수

context

TurnContext

(xref:botbuilder-core. TurnContext), 사용자와의 현재 대화 턴에 대한 컨텍스트입니다.

instance

DialogInstance

(xref:botbuilder-dialogs. DialogInstance), 스택에 있는 대화 상자의 인스턴스입니다.

반환

Promise<void>

비동기 작업을 나타내는 Promise.

Prompt.repromptDialog 상속된

resumeDialog(DialogContext, DialogReason, any)

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

function resumeDialog(dc: DialogContext, _reason: DialogReason, _result?: any): Promise<DialogTurnResult>

매개 변수

dc

DialogContext

대화의 현재 전환에 대한 DialogContext입니다.

_reason

DialogReason

대화가 다시 시작된 이유를 나타내는 열거형입니다.

_result

any

선택 사항으로, 스택의 이전 대화 상자에서 반환된 값입니다. 반환되는 값의 형식은 이전 대화 상자에 따라 달라집니다.

반환

Promise<DialogTurnResult>

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

설명

작업이 성공하면 결과는 대화 상자에서 턴이 처리된 후에도 대화 상자가 여전히 활성 상태인지 여부를 나타냅니다.

Prompt.resumeDialog 상속된