AttachmentInput class

참조

패키지:: botbuilder-dialogs-adaptive

사용자에게 파일을 보내라는 메시지를 표시하는 입력 대화 상자입니다.

Extends: InputDialog

생성자

AttachmentInput(string, Partial<Activity> | string)

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

속성

$kind
outputFormat

상속된 속성

allowInterruptions	중단 정책입니다.
alwaysPrompt	값이 있는지 여부에 관계없이 입력이 항상 사용자에게 메시지를 표시해야 하는지 여부를 나타내는 값입니다.
defaultValue	maxTurnCount를 초과할 때 입력 대화 상자의 기본값입니다.
defaultValueResponse	maxTurnCount에 도달하고 기본값이 사용될 때 보낼 활동 템플릿입니다.
disabled	true이면 이 작업을 사용하지 않도록 설정하는 선택적 식입니다.
EndOfTurn	기본 턴 종료 결과를 가져옵니다.
id
invalidPrompt	제공된 값이 유효하지 않을 때마다 사용자에게 보낼 활동 템플릿입니다.
maxTurnCount	대화 상자가 포기되기 전에 사용자에게 이 값을 요청하는 최대 횟수입니다.
OPTIONS_PROPERTY
prompt	사용자에게 보낼 활동입니다.
property	입력이 바인딩될 값 식입니다.
telemetryClient
TURN_COUNT_PROPERTY
unrecognizedPrompt	프롬프트를 다시 시도하기 위한 활동 템플릿입니다.
validations	입력의 유효성을 검사하기 위해 실행할 식입니다.
value	입력 프롬프트를 초기화하는 데 사용할 수 있는 값 식입니다.
VALUE_PROPERTY

메서드

getConverter(Object)

상속된 메서드

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

생성자 세부 정보

AttachmentInput(string, Partial<Activity> | string)

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

new AttachmentInput(property?: string, prompt?: Partial<Activity> | string)

매개 변수

property: string

선택적. 입력이 바인딩될 값 식입니다.

prompt: Partial<Activity> | string

선택적. 활동은 사용자에게 보낼 있습니다. 문자열이 지정된 경우 ActivityTemplate인스턴스화합니다.

속성 세부 정보

$kind

static $kind: string

속성 값

string

outputFormat

outputFormat: EnumExpression<AttachmentOutputFormat>

속성 값

EnumExpression<AttachmentOutputFormat>

상속된 속성 세부 정보

allowInterruptions

중단 정책입니다.

allowInterruptions: BoolExpression

속성 값

BoolExpression

InputDialog.allowInterruptions 상속된

alwaysPrompt

값이 있는지 여부에 관계없이 입력이 항상 사용자에게 메시지를 표시해야 하는지 여부를 나타내는 값입니다.

alwaysPrompt: BoolExpression

속성 값

BoolExpression

InputDialog.alwaysPrompt 상속된

defaultValue

maxTurnCount를 초과할 때 입력 대화 상자의 기본값입니다.

defaultValue?: ValueExpression

속성 값

ValueExpression

InputDialog.defaultValue 상속된

defaultValueResponse

maxTurnCount에 도달하고 기본값이 사용될 때 보낼 활동 템플릿입니다.

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

속성 값

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.defaultValueResponse 상속된

disabled

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

disabled?: BoolExpression

속성 값

BoolExpression

InputDialog.disabled 상속된

EndOfTurn

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

static EndOfTurn: DialogTurnResult

속성 값

DialogTurnResult

설명

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

dialog.EndOfTurn에서 상속된

id

id: string

속성 값

string

Dialog.id 상속된

invalidPrompt

제공된 값이 유효하지 않을 때마다 사용자에게 보낼 활동 템플릿입니다.

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

속성 값

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.invalidPrompt 상속됨

maxTurnCount

대화 상자가 포기되기 전에 사용자에게 이 값을 요청하는 최대 횟수입니다.

maxTurnCount?: IntExpression

속성 값

IntExpression

InputDialog.maxTurnCount 상속된

OPTIONS_PROPERTY

static OPTIONS_PROPERTY: string

속성 값

string

InputDialog.OPTIONS_PROPERTY 상속된

prompt

사용자에게 보낼 활동입니다.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

속성 값

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.prompt 상속된

property

입력이 바인딩될 값 식입니다.

property: StringExpression

속성 값

StringExpression

InputDialog.property 상속된

telemetryClient

telemetryClient: BotTelemetryClient

속성 값

BotTelemetryClient

Dialog.telemetryClient에서 상속된

TURN_COUNT_PROPERTY

static TURN_COUNT_PROPERTY: string

속성 값

string

InputDialog.TURN_COUNT_PROPERTY 상속된

unrecognizedPrompt

프롬프트를 다시 시도하기 위한 활동 템플릿입니다.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

속성 값

TemplateInterface<Partial<Activity>, DialogStateManager>

InputDialog.unrecognizedPrompt 상속된

validations

입력의 유효성을 검사하기 위해 실행할 식입니다.

validations: string[]

속성 값

string[]

InputDialog.validations 상속된

value

입력 프롬프트를 초기화하는 데 사용할 수 있는 값 식입니다.

value: ValueExpression

속성 값

ValueExpression

InputDialog.value 상속된

VALUE_PROPERTY

static VALUE_PROPERTY: string

속성 값

string

InputDialog.VALUE_PROPERTY 상속된

메서드 세부 정보

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

매개 변수

property: Object

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

반환

Converter | ConverterFactory

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

상속된 메서드 세부 정보

beginDialog(DialogContext, any)

대화 시작되어 대화 스택으로 푸시될 때 호출됩니다.

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

매개 변수

dc: DialogContext

현재 대화 전환에 대한 DialogContext.

options: any

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

반환

Promise<DialogTurnResult>

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

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

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

InputDialog.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 현재 대화 상자가 사용자의 입력을 다시 요청해야 하는 경우 이 메서드를 호출합니다. 이 메서드는 프롬프트 대화 상자에 대해 구현됩니다.

참조

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>

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

InputDialog.resumeDialog 상속된

다음을 통해 공유

AttachmentInput class

생성자

속성

상속된 속성

메서드

상속된 메서드

생성자 세부 정보

AttachmentInput(string, Partial<Activity> | string)

매개 변수

속성 세부 정보

$kind

속성 값

outputFormat

속성 값

상속된 속성 세부 정보

allowInterruptions

속성 값

alwaysPrompt

속성 값

defaultValue

속성 값

defaultValueResponse

속성 값

disabled

속성 값

EndOfTurn

속성 값

설명

id

속성 값

invalidPrompt

속성 값

maxTurnCount

속성 값

OPTIONS_PROPERTY

속성 값

prompt

속성 값

property

속성 값

telemetryClient

속성 값

TURN_COUNT_PROPERTY

속성 값

unrecognizedPrompt

속성 값

validations

속성 값

value

속성 값

VALUE_PROPERTY

속성 값

메서드 세부 정보

getConverter(Object)

매개 변수

반환

상속된 메서드 세부 정보

beginDialog(DialogContext, any)

매개 변수

반환

configure(Record<string, unknown>)

매개 변수

반환

continueDialog(DialogContext)

매개 변수

반환

endDialog(TurnContext, DialogInstance, DialogReason)

매개 변수

반환

설명

getVersion()

반환

설명

onDialogEvent(DialogContext, DialogEvent)

매개 변수

반환

repromptDialog(TurnContext, DialogInstance)

매개 변수

반환