BeginSkill class

참조

패키지:: botbuilder-dialogs-adaptive

기술을 시작합니다.

Extends: SkillDialog

생성자

새 'BeginSkillDialog 인스턴스를 만듭니다.

속성

$kind
activity	활동에 대한 템플릿입니다.
activityProcessed	새 대화 상자에서 작업을 처리해야 하는지 여부를 나타내는 값입니다.
allowInterruptions	중단 정책입니다.
botId	기술을 호출할 Microsoft 앱 ID입니다.
connectionName	선택적. 부모 봇의 OAuth 연결 이름입니다.
disabled	true이면 이 작업을 사용하지 않도록 설정하는 선택적 식입니다.
resultProperty	대화 결과를 저장할 선택적 속성 경로입니다.
skillAppId	기술에 대한 Microsoft 앱 ID입니다.
skillEndpoint	기술에 대한 `/api/messages` 엔드포인트입니다.
skillHostEndpoint	기술 호스트에 대한 콜백 URL입니다.

상속된 속성

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

메서드

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

상속된 메서드

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

생성자 세부 정보

BeginSkill(SkillDialogOptions)

새 'BeginSkillDialog 인스턴스를 만듭니다.

new BeginSkill(options?: SkillDialogOptions)

매개 변수

options: SkillDialogOptions

기술 대화 상자를 구성하는 데 사용되는 선택적 옵션입니다.

속성 세부 정보

$kind

static $kind: string

속성 값

string

activity

활동에 대한 템플릿입니다.

activity: TemplateInterface<Partial<Activity>, DialogStateManager>

속성 값

TemplateInterface<Partial<Activity>, DialogStateManager>

activityProcessed

새 대화 상자에서 작업을 처리해야 하는지 여부를 나타내는 값입니다.

activityProcessed: BoolExpression

속성 값

BoolExpression

설명

기본값은 true입니다. 즉, 새 대화 상자가 활동을 않아야 합니다. 새 대화 상자로 활동을 디스패치하려면 이 값을 false로 설정할 수 있습니다.

allowInterruptions

중단 정책입니다.

allowInterruptions: BoolExpression

속성 값

BoolExpression

botId

기술을 호출할 Microsoft 앱 ID입니다.

botId: StringExpression

속성 값

StringExpression

설명

설정에서 봇 ID를 검색하는 =settings.MicrosoftAppId 값으로 디폴스합니다.

connectionName

선택적. 부모 봇의 OAuth 연결 이름입니다.

connectionName: StringExpression

속성 값

StringExpression

disabled

true이면 이 작업을 사용하지 않도록 설정하는 선택적 식입니다.

disabled?: BoolExpression

속성 값

BoolExpression

resultProperty

대화 결과를 저장할 선택적 속성 경로입니다.

resultProperty?: StringExpression

속성 값

StringExpression

skillAppId

기술에 대한 Microsoft 앱 ID입니다.

skillAppId: StringExpression

속성 값

StringExpression

skillEndpoint

기술에 대한 /api/messages 엔드포인트입니다.

skillEndpoint: StringExpression

속성 값

StringExpression

skillHostEndpoint

기술 호스트에 대한 콜백 URL입니다.

skillHostEndpoint: StringExpression

속성 값

StringExpression

설명

설정에서 엔드포인트를 검색하는 =settings.SkillHostEndpoint 값으로 디폴스합니다.

상속된 속성 세부 정보

EndOfTurn

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

static EndOfTurn: DialogTurnResult

속성 값

DialogTurnResult

설명

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

dialog.EndOfTurn에서 상속된

id

id: string

속성 값

string

Dialog.id 상속된

telemetryClient

telemetryClient: BotTelemetryClient

속성 값

BotTelemetryClient

Dialog.telemetryClient에서 상속된

메서드 세부 정보

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(turnContext: TurnContext, instance: DialogInstance, reason: DialogReason): Promise<void>

매개 변수

turnContext: TurnContext

(xref:botbuilder-core. TurnContext), 이 턴의 컨텍스트 개체입니다.

instance: DialogInstance

(xref:botbuilder-dialogs. DialogInstance), 대화 스택에서 이 대화 상자의 인스턴스와 연결된 상태 정보입니다.

reason: DialogReason

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

반환

Promise<void>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

매개 변수

property: Object

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

반환

Converter | ConverterFactory

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

repromptDialog(TurnContext, DialogInstance)

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

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

매개 변수

turnContext: TurnContext

(xref:botbuilder-core. TurnContext), 이 턴의 컨텍스트 개체입니다.

instance: DialogInstance

(xref:botbuilder-dialogs. DialogInstance), 이 대화 상자의 상태 정보입니다.

반환

Promise<void>

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

resumeDialog(DialogContext, DialogReason, any)

자식 대화 상자 순서를 완료하고 이 대화 상자로 컨트롤을 반환할 때 호출됩니다.

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult<any>>

매개 변수

dc: DialogContext

현재 대화 전환에 대한 DialogContext.

reason: DialogReason

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

result: any

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

반환

Promise<DialogTurnResult<any>>

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

상속된 메서드 세부 정보

configure(Record<string, unknown>)

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

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

매개 변수

config: Record<string, unknown>

적용할 구성 설정입니다.

반환

this

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

Configurable.configure에서 상속된

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

다음을 통해 공유

BeginSkill class

생성자

속성

상속된 속성

메서드

상속된 메서드

생성자 세부 정보

BeginSkill(SkillDialogOptions)

매개 변수

속성 세부 정보

$kind

속성 값

activity

속성 값

activityProcessed

속성 값

설명

allowInterruptions

속성 값

botId

속성 값

설명

connectionName

속성 값

disabled

속성 값

resultProperty

속성 값

skillAppId

속성 값

skillEndpoint

속성 값

skillHostEndpoint

속성 값

설명

상속된 속성 세부 정보

EndOfTurn

속성 값

설명

id

속성 값

telemetryClient

속성 값

메서드 세부 정보

beginDialog(DialogContext, BeginSkillDialogOptions)

매개 변수

반환

continueDialog(DialogContext)

매개 변수

반환

endDialog(TurnContext, DialogInstance, DialogReason)

매개 변수

반환

getConverter(Object)

매개 변수

반환

repromptDialog(TurnContext, DialogInstance)

매개 변수

반환

resumeDialog(DialogContext, DialogReason, any)

매개 변수

반환

상속된 메서드 세부 정보

configure(Record<string, unknown>)

매개 변수

반환

getVersion()

반환

설명

onDialogEvent(DialogContext, DialogEvent)

매개 변수

반환