SkillDialog class

패키지:

botbuilder-dialogs

기술에 대한 원격 호출을 래핑할 수 있는 특수 대화 상자입니다.

Extends

Dialog<Partial<BeginSkillDialogOptions>>

설명

beginDialog의 옵션 매개 변수는 대화 상자의 초기 매개 변수가 있는 BeginSkillDialogOptions 인스턴스여야 합니다.

생성자

SkillDialog(SkillDialogOptions, string)

기술에 대한 원격 호출을 래핑할 수 있는 샘플 대화 상자입니다.

속성

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

상속된 속성

EndOfTurn

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

메서드

beginDialog(DialogContext, BeginSkillDialogOptions)	기술 대화 상자가 시작되고 대화 상자 스택으로 푸시될 때 호출됩니다.
continueDialog(DialogContext)	기술 대화 상자가 계속되면 호출됩니다. 여기서 활성 대화 상자이며 사용자가 새 활동회신합니다.
endDialog(TurnContext, DialogInstance, DialogReason)	기술 대화 상자가 종료되면 호출됩니다.
repromptDialog(TurnContext, DialogInstance)	기술 대화 상자가 사용자에게 입력하라는 메시지를 다시 표시해야 할 때 호출됩니다.
resumeDialog(DialogContext, DialogReason, any)	자식 기술 대화 상자가 턴을 완료하고 컨트롤을 이 대화 상자로 반환할 때 호출됩니다.

상속된 메서드

configure(Record<string, unknown>)	개체를 구성하기 위한 Fluent 메서드입니다.
getConverter(string)
getVersion()	다시 배포할 때 봇 변경 내용을 검색하는 데 사용되는 인코딩된 문자열입니다.
onDialogEvent(DialogContext, DialogEvent)	현재 대화 상자 또는 현재 대화 상자가 시작된 대화 상자에서 DialogContext.emitEvent()사용하여 이벤트가 발생할 때 호출됩니다.

생성자 세부 정보

SkillDialog(SkillDialogOptions, string)

기술에 대한 원격 호출을 래핑할 수 있는 샘플 대화 상자입니다.

new SkillDialog(dialogOptions: SkillDialogOptions, dialogId?: string)

매개 변수

dialogOptions

SkillDialogOptions

기술 대화 상자를 실행하는 옵션입니다.

dialogId

string

대화 상자의 ID입니다.

설명

beginDialog() 옵션 매개 변수는 대화 상자의 초기 매개 변수가 있는 SkillDialogArgs 개체여야 합니다.

속성 세부 정보

id

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

string id

속성 값

string

대화 상자의 ID입니다.

설명

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

telemetryClient

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

BotTelemetryClient telemetryClient

속성 값

BotTelemetryClient

BotTelemetryClient는 로깅에 사용할.

상속된 속성 세부 정보

EndOfTurn

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

static EndOfTurn: DialogTurnResult

속성 값

DialogTurnResult

설명

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

dialog.EndOfTurn 상속된

메서드 세부 정보

beginDialog(DialogContext, BeginSkillDialogOptions)

기술 대화 상자가 시작되고 대화 상자 스택으로 푸시될 때 호출됩니다.

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

매개 변수

dc

DialogContext

현재 대화 전환에 대한 DialogContext.

options

BeginSkillDialogOptions

대화 상자에 전달할 초기 정보입니다.

반환

Promise<DialogTurnResult>

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

설명

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

continueDialog(DialogContext)

기술 대화 상자가 계속되면 호출됩니다. 여기서 활성 대화 상자이며 사용자가 새 활동회신합니다.

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

매개 변수

dc

DialogContext

현재 대화 전환에 대한 DialogContext.

반환

Promise<DialogTurnResult>

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

설명

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

endDialog(TurnContext, DialogInstance, DialogReason)

기술 대화 상자가 종료되면 호출됩니다.

function endDialog(context: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

매개 변수

context

TurnContext

이 턴에 대한 TurnContext 개체입니다.

instance

DialogInstance

대화 상자 스택에서 이 대화 상자의 인스턴스와 연결된 상태 정보입니다.

reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) 대화가 종료된 이유입니다.

반환

Promise<void>

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

repromptDialog(TurnContext, DialogInstance)

기술 대화 상자가 사용자에게 입력하라는 메시지를 다시 표시해야 할 때 호출됩니다.

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

매개 변수

context

TurnContext

이 턴에 대한 TurnContext 개체입니다.

instance

DialogInstance

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

반환

Promise<void>

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

resumeDialog(DialogContext, DialogReason, any)

자식 기술 대화 상자가 턴을 완료하고 컨트롤을 이 대화 상자로 반환할 때 호출됩니다.

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

매개 변수

dc

DialogContext

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

_reason

DialogReason

(xref:botbuilder-dialogs. DialogReason) 대화가 다시 시작된 이유입니다.

_result

any

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

반환

Promise<DialogTurnResult>

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

상속된 메서드 세부 정보

configure(Record<string, unknown>)

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

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

매개 변수

config

Record<string, unknown>

적용할 구성 설정입니다.

반환

this

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

Configurable.configure 상속된

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 상속된