OAuthInput class

참조

패키지:: botbuilder-dialogs-adaptive

OAuthInput은 사용자에게 로그인하라는 메시지를 표시합니다.

Extends: InputDialog

생성자

OAuthInput(string, string, string, number)

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

속성

$kind
connectionName	사용 중인 OAuth 연결의 이름입니다.
text	(선택 사항) 로그인 카드에 포함할 추가 텍스트입니다.
timeout	(선택 사항) 프롬프트에서 사용자가 인증할 때까지 대기하는 시간(밀리초)입니다. 기본값은 `900,000` 값(15분)입니다.
title	카드 로그인 단추의 제목입니다.

상속된 속성

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

메서드

beginDialog(DialogContext, PromptOptions)	프롬프트 대화 대화 스택으로 푸시되고 활성화될 때 호출됩니다.
continueDialog(DialogContext)	프롬프트 대화 활성 대화 상자이고 사용자가 새 활동으로 회신할 때 호출됩니다.
getConverter(Object)
getUserToken(DialogContext, string)	현재 사용자의 저장된 토큰을 검색하려고 시도합니다.
signOutUser(DialogContext)	사용자를 서비스에서 로그아웃합니다.

상속된 메서드

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

생성자 세부 정보

OAuthInput(string, string, string, number)

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

new OAuthInput(connectionName?: string, title?: string, text?: string, timeout?: number)

매개 변수

connectionName: string

선택적. 사용 중인 OAuth 연결의 이름입니다.

title: string

선택적. 카드 로그인 단추의 제목입니다.

text: string

선택적. 로그인 카드에 포함할 추가 텍스트입니다.

timeout: number

선택적. 프롬프트가 사용자가 인증할 때까지 대기하는 시간(밀리초)입니다.

속성 세부 정보

$kind

static $kind: string

속성 값

string

connectionName

사용 중인 OAuth 연결의 이름입니다.

connectionName: StringExpression

속성 값

StringExpression

text

(선택 사항) 로그인 카드에 포함할 추가 텍스트입니다.

text?: StringExpression

속성 값

StringExpression

timeout

(선택 사항) 프롬프트에서 사용자가 인증할 때까지 대기하는 시간(밀리초)입니다. 기본값은 900,000 값(15분)입니다.

timeout?: IntExpression

속성 값

IntExpression

title

카드 로그인 단추의 제목입니다.

title: StringExpression

속성 값

StringExpression

상속된 속성 세부 정보

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

메서드 세부 정보

beginDialog(DialogContext, PromptOptions)

프롬프트 대화 대화 스택으로 푸시되고 활성화될 때 호출됩니다.

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

매개 변수

dc: DialogContext

현재 대화 전환에 대한 DialogContext.

options: PromptOptions

선택적. 시작 중인 프롬프트에 전달할 추가 정보입니다.

반환

Promise<DialogTurnResult>

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

continueDialog(DialogContext)

프롬프트 대화 활성 대화 상자이고 사용자가 새 활동으로 회신할 때 호출됩니다.

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

매개 변수

dc: DialogContext

현재 대화 전환에 대한 DialogContext.

반환

Promise<DialogTurnResult>

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

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

매개 변수

property: Object

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

반환

Converter | ConverterFactory

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

getUserToken(DialogContext, string)

현재 사용자의 저장된 토큰을 검색하려고 시도합니다.

function getUserToken(dc: DialogContext, code?: string): Promise<TokenResponse | undefined>

매개 변수

dc: DialogContext

컨텍스트는 조회 중인 사용자를 참조합니다.

code: string

(선택 사항) 사용자로부터 받은 로그인 코드입니다.

반환

Promise<TokenResponse | undefined>

비동기 작업을 나타내는 프라미스입니다.

signOutUser(DialogContext)

사용자를 서비스에서 로그아웃합니다.

function signOutUser(dc: DialogContext): Promise<void>

매개 변수

dc: DialogContext

로그아웃 중인 사용자를 참조하는 컨텍스트입니다.

반환

Promise<void>

비동기 작업을 나타내는 프라미스입니다.

설명

이 예제에서는 프롬프트의 인스턴스를 만든 다음 사용자를 로그아웃하는 방법을 보여 줍니다.

const prompt = new OAuthPrompt({
    connectionName: 'GitConnection',
    title: 'Login To GitHub'
});
await prompt.signOutUser(context);

상속된 메서드 세부 정보

configure(Record<string, unknown>)

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

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

매개 변수

config: Record<string, unknown>

적용할 구성 설정입니다.

반환

this

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

Configurable.configure에서 상속된

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

다음을 통해 공유

OAuthInput class

생성자

속성

상속된 속성

메서드

상속된 메서드

생성자 세부 정보

OAuthInput(string, string, string, number)

매개 변수

속성 세부 정보

$kind

속성 값

connectionName

속성 값

text

속성 값

timeout

속성 값

title

속성 값

상속된 속성 세부 정보

allowInterruptions

속성 값

alwaysPrompt

속성 값

defaultValue

속성 값

defaultValueResponse

속성 값

disabled

속성 값

EndOfTurn

속성 값

설명

id

속성 값

invalidPrompt

속성 값

maxTurnCount

속성 값

OPTIONS_PROPERTY

속성 값

prompt

속성 값

property

속성 값

telemetryClient

속성 값

TURN_COUNT_PROPERTY

속성 값

unrecognizedPrompt

속성 값

validations

속성 값

value

속성 값

VALUE_PROPERTY

속성 값

메서드 세부 정보

beginDialog(DialogContext, PromptOptions)

매개 변수

반환

continueDialog(DialogContext)

매개 변수

반환

getConverter(Object)

매개 변수

반환

getUserToken(DialogContext, string)

매개 변수

반환

signOutUser(DialogContext)

매개 변수

반환

설명

상속된 메서드 세부 정보

configure(Record<string, unknown>)

매개 변수

반환