ForEach class

패키지:

botbuilder-dialogs-adaptive

메모리 내 목록 또는 컬렉션의 각 항목에 대해 작업 집합을 한 번 실행합니다.

Extends

ActionScope<O>

생성자

ForEach()	Foreach 클래스의 새 인스턴스를 초기화합니다.
ForEach(string, Dialog[])	Foreach 클래스의 새 인스턴스를 초기화합니다.

속성

$kind
disabled	true이면 이 작업을 사용하지 않도록 설정하는 선택적 식입니다.
index	항목 인덱스 속성 경로 식입니다.
itemsProperty	항목 컬렉션에 대한 속성 경로 식입니다.
value	항목 값에 대한 속성 경로 식입니다.

상속된 속성

actions	실행할 작업입니다.
EndOfTurn	기본 턴 종료 결과를 가져옵니다.
id
telemetryClient

메서드

beginDialog(DialogContext, O)	새 대화 시작하여 대화 스택으로 푸시합니다.
getConverter(Object)
getDependencies()	자식 대화 종속성을 가져오므로 컨테이너 대화 상자 집합에 추가할 수 있습니다.

상속된 메서드

configure(Record<string, unknown>)	개체를 구성하기 위한 Fluent 메서드입니다.
continueDialog(DialogContext)	대화활성 대화 상자이고 사용자가 새 활동으로 회신하는계속되면 호출됩니다.
endDialog(TurnContext, DialogInstance, DialogReason)	파생 클래스에서 재정의된 경우 종료되기 전에 대화 상자에 대한 정리를 수행합니다.
getVersion()	이 대화 상자의 버전을 나타내는 고유한 string 가져옵니다. 버전이 바뀌면 대화 시스템이 DialogChanged 이벤트를 내보낸다.
onDialogEvent(DialogContext, DialogEvent)	현재 대화 상자 또는 현재 대화 상자가 시작된 대화 상자에서 DialogContext.emitEvent()사용하여 이벤트가 발생할 때 호출됩니다.
repromptDialog(TurnContext, DialogInstance)	파생 클래스에서 재정의된 경우 입력을 위해 사용자를 다시 프롬프트합니다.
resumeDialog(DialogContext, DialogReason, any)	자식 대화 상자 순서를 완료하고 이 대화 상자로 컨트롤을 반환할 때 호출됩니다.

생성자 세부 정보

ForEach()

Foreach 클래스의 새 인스턴스를 초기화합니다.

new ForEach()

ForEach(string, Dialog[])

Foreach 클래스의 새 인스턴스를 초기화합니다.

new ForEach(itemsProperty: string, actions: Dialog[])

매개 변수

itemsProperty

string

항목 컬렉션에 대한 속성 경로 식입니다.

actions

Dialog[]

실행할 작업입니다.

속성 세부 정보

$kind

static $kind: string

속성 값

string

disabled

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

disabled?: BoolExpression

속성 값

BoolExpression

index

항목 인덱스 속성 경로 식입니다.

index: StringExpression

속성 값

StringExpression

itemsProperty

항목 컬렉션에 대한 속성 경로 식입니다.

itemsProperty: StringExpression

속성 값

StringExpression

value

항목 값에 대한 속성 경로 식입니다.

value: StringExpression

속성 값

StringExpression

상속된 속성 세부 정보

actions

실행할 작업입니다.

actions: Dialog[]

속성 값

Dialog[]

ActionScope.actions 상속된

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

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

getDependencies()

자식 대화 종속성을 가져오므로 컨테이너 대화 상자 집합에 추가할 수 있습니다.

function getDependencies(): Dialog[]

반환

Dialog[]

자식 대화 종속성입니다.

상속된 메서드 세부 정보

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.

ActionScope.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()

이 대화 상자의 버전을 나타내는 고유한 string 가져옵니다. 버전이 바뀌면 대화 시스템이 DialogChanged 이벤트를 내보낸다.

function getVersion(): string

반환

string

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

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

현재 대화 전환에 대한 DialogContext.

_reason

DialogReason

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

result

any

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

반환

Promise<DialogTurnResult>

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

ActionScope.resumeDialog 상속된