Поделиться через

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

Комментарии

Этот результат указывает, что диалоговое окно (или логический шаг в диалоговом окне) завершило обработку текущего шага, по-прежнему активно и ожидает дополнительных входных данных.

унаследован от диалогового окна.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 вызывает этот метод при завершении текущего диалога.

См. также

унаследован от Dialog.endDialog

getVersion()

Кодированная строка, используемая для обнаружения изменений бота при повторном развертывании.

function getVersion(): string

Возвращаемое значение

string

Уникальная строка, которая должна изменяться только при изменении диалогового окна таким образом, чтобы перезапустить диалоговое окно.

Комментарии

По умолчанию возвращается диалоговое окно идентификатор, но его можно переопределить, чтобы обеспечить более точную логику обнаружения изменений. Любое диалоговое окно в стеке с изменением версии приведет к возникновению события versionChanged. Если это событие не обрабатывается ботом, возникает ошибка, в результате чего выполняется логика обработчика ошибок ботов.

Возврат пустой строки отключит отслеживание версий для компонента вместе.

унаследован от Dialog.getVersion

onDialogEvent(DialogContext, DialogEvent)

Вызывается при возникновении события, используя DialogContext.emitEvent(), текущим диалогом или диалогом, запущенным текущим диалогом.

function onDialogEvent(dc: DialogContext, e: DialogEvent): Promise<boolean>

Параметры

dc

DialogContext

Контекст диалогового окна для текущей очереди беседы.

e

DialogEvent

Возникает событие.

Возвращаемое значение

Promise<boolean>

Значение True, если событие обрабатывается текущим диалогом, а пузырьк должен остановиться.

унаследован от диалогового окна.onDialogEvent

repromptDialog(TurnContext, DialogInstance)

При переопределении в производном классе переиздает пользователя для ввода.

function repromptDialog(_context: TurnContext, _instance: DialogInstance): Promise<void>

Параметры

_context

TurnContext

Объект контекста для поворота.

_instance

DialogInstance

Текущие сведения о состоянии для этого диалогового окна.

Возвращаемое значение

Promise<void>

Комментарии

Производные диалоги, поддерживающие проверку и логику повторного запроса, должны переопределить этот метод. По умолчанию этот метод не действует.

DialogContext вызывает этот метод, когда текущее диалоговое окно должно повторно запрашивать входные данные от пользователя. Этот метод реализуется для диалоговых окон запроса.

См. также

унаследован от диалогового окна "Диалоговое окно.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