SendActivity class

패키지:

botbuilder-dialogs-adaptive

사용자에게 활동을 다시 보냅니다.

Extends

Dialog<O>

생성자

SendActivity(Partial<Activity> | string)

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

속성

$kind
activity	작업에 대한 템플릿을 가져오거나 설정합니다.
disabled	true이면 이 작업을 사용하지 않도록 설정하는 선택적 식입니다.

상속된 속성

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

메서드

beginDialog(DialogContext, O)	새 대화 시작하여 대화 스택으로 푸시합니다.
getConverter(Object)

상속된 메서드

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

생성자 세부 정보

SendActivity(Partial<Activity> | string)

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

new SendActivity(activity?: Partial<Activity> | string)

매개 변수

activity

Partial<Activity> | string

(xref:botframework-schema. 활동) 또는 사용자를 보낼 메시지 텍스트입니다.

속성 세부 정보

$kind

static $kind: string

속성 값

string

activity

작업에 대한 템플릿을 가져오거나 설정합니다.

activity: TemplateInterface<Partial<Activity>, D & O>

속성 값

TemplateInterface<Partial<Activity>, D & O>

disabled

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

disabled?: BoolExpression

속성 값

BoolExpression

상속된 속성 세부 정보

EndOfTurn

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

static EndOfTurn: DialogTurnResult

속성 값

DialogTurnResult

설명

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

dialog.EndOfTurn에서 상속된

id

id: string

속성 값

string

Dialog.id 상속된

telemetryClient

telemetryClient: BotTelemetryClient

속성 값

BotTelemetryClient

Dialog.telemetryClient에서 상속된

메서드 세부 정보

beginDialog(DialogContext, O)

새 대화 시작하여 대화 스택으로 푸시합니다.

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

매개 변수

dc

DialogContext

현재 대화 전환에 대한 DialogContext.

options

O

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

반환

Promise<DialogTurnResult>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

매개 변수

property

Object

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

반환

Converter | ConverterFactory

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

상속된 메서드 세부 정보

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

현재 대화 상자 턴의 컨텍스트입니다.

반환

Promise<DialogTurnResult>

대화 상자 턴 결과로 해결되는 약속입니다.

설명

다중 턴 대화를 지원하는 파생 대화 상자는 이 메서드를 재정의해야 합니다. 기본적으로 이 메서드는 대화가 완료되었음을 알리고 반환합니다.

DialogContext 대화 상자를 계속하면 이 메서드를 호출합니다.

이 대화 상자가 완료되었음을 대화 컨텍스트에 알리려면 이 메서드를 종료하기 전에 dialogContext.endDialog 기다립니다.

참조

• DialogContext.continueDialog

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

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

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

_instance

DialogInstance

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

반환

Promise<void>

설명

유효성 검사 및 다시 프롬프트 논리를 지원하는 파생 대화 상자는 이 메서드를 재정의해야 합니다. 기본적으로 이 메서드는 효과가 없습니다.

DialogContext 현재 대화 상자가 사용자의 입력을 다시 요청해야 하는 경우 이 메서드를 호출합니다. 이 메서드는 프롬프트 대화 상자에 대해 구현됩니다.

참조

• DialogContext.repromptDialog
• 프롬프트

Dialog.repromptDialog에서 상속된

resumeDialog(DialogContext, DialogReason, any)

파생 클래스에서 재정의된 경우 스택에서 위의 대화 상자가 완료된 후 대화 상자를 다시 시작합니다.

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

매개 변수

dc

DialogContext

현재 대화 상자 턴의 컨텍스트입니다.

reason

DialogReason

대화 상자가 재개되는 이유입니다. 일반적으로 DialogReason.endCalled .

result

any

선택적. 종료된 대화 상자의 반환 값(있는 경우)입니다.

반환

Promise<DialogTurnResult>

대화 상자 턴 결과로 해결되는 약속입니다.

설명

다중 턴 대화를 지원하는 파생 대화 상자는 이 메서드를 재정의해야 합니다. 기본적으로 이 메서드는 대화가 완료되었음을 알리고 반환합니다.

DialogContext 대화 상자를 다시 시작할 때 이 메서드를 호출합니다. 스택의 이전 대화 상자에서 값을 반환한 경우 해당 값은 result 매개 변수에 있습니다.

자식 대화 상자를 시작하려면 DialogContext.beginDialog 또는 dialogContext.prompt사용합니다. 그러나 이 대화 상자가 반드시 자식 대화 상자를 시작한 대화가 아닐 수도 있습니다. 이 대화 상자가 완료되었음을 대화 컨텍스트에 알리려면 이 메서드를 종료하기 전에 dialogContext.endDialog 기다립니다.

참조

• DialogContext.endDialog

Dialog.resumeDialog에서 상속된