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

InputDialog class

  • Ссылка
Пакет:
botbuilder-dialogs-adaptive

Определяет диалоговые окна ввода.

Extends

Dialog

Конструкторы

InputDialog(string, Partial<Activity> | string)

Инициализирует новый экземпляр класса InputDialog

Свойства

allowInterruptions

Политика прерывания.
alwaysPrompt

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

Значение по умолчанию для диалогового окна ввода при превышении maxTurnCount.
defaultValueResponse

Шаблон действия для отправки при достижении maxTurnCount и используется значение по умолчанию.
disabled

Необязательное выражение, которое, если задано значение true, отключит это действие.
invalidPrompt

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

Максимальное количество раз, когда пользователь запрашивает это значение до того, как откроется диалоговое окно.
OPTIONS_PROPERTY
prompt

Действие для отправки пользователю.
property

Выражение значения, к которому будут привязаны входные данные.
TURN_COUNT_PROPERTY
unrecognizedPrompt

Шаблон действия для повтора запроса.
validations

Выражения, выполняемые для проверки входных данных.
value

Выражение значения, которое можно использовать для инициализации входного запроса.
VALUE_PROPERTY

Унаследованные свойства

EndOfTurn

Возвращает результат конца по умолчанию.
id
telemetryClient

Методы

beginDialog(DialogContext, any)

Вызывается при запуске диалогового окна и отправке в стек диалогов.
continueDialog(DialogContext)

Вызывается, когда диалогового окна продолжается, где это активное диалоговое окно и пользователь отвечает с новым действием.
getConverter(Object)
resumeDialog(DialogContext, DialogReason, any)

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

Наследуемые методы

configure(Record<string, unknown>)

Метод Fluent для настройки объекта.
endDialog(TurnContext, DialogInstance, DialogReason)

При переопределении в производном классе выполняет очистку диалогового окна перед завершением.
getVersion()

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

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

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

Сведения о конструкторе

InputDialog(string, Partial<Activity> | string)

Инициализирует новый экземпляр класса InputDialog

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

Параметры

property

string

Необязательный. Выражение значения, к которому будут привязаны входные данные.

prompt

Partial<Activity> | string

Необязательный. Действие для отправки пользователю, если указана строка, создается экземпляр ActivityTemplate.

Сведения о свойстве

allowInterruptions

Политика прерывания.

allowInterruptions: BoolExpression

Значение свойства

BoolExpression

alwaysPrompt

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

alwaysPrompt: BoolExpression

Значение свойства

BoolExpression

defaultValue

Значение по умолчанию для диалогового окна ввода при превышении maxTurnCount.

defaultValue?: ValueExpression

Значение свойства

ValueExpression

defaultValueResponse

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

defaultValueResponse: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

disabled

Необязательное выражение, которое, если задано значение true, отключит это действие.

disabled?: BoolExpression

Значение свойства

BoolExpression

invalidPrompt

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

invalidPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

maxTurnCount

Максимальное количество раз, когда пользователь запрашивает это значение до того, как откроется диалоговое окно.

maxTurnCount?: IntExpression

Значение свойства

IntExpression

OPTIONS_PROPERTY 

static OPTIONS_PROPERTY: string

Значение свойства

string

prompt

Действие для отправки пользователю.

prompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

property

Выражение значения, к которому будут привязаны входные данные.

property: StringExpression

Значение свойства

StringExpression

TURN_COUNT_PROPERTY 

static TURN_COUNT_PROPERTY: string

Значение свойства

string

unrecognizedPrompt

Шаблон действия для повтора запроса.

unrecognizedPrompt: TemplateInterface<Partial<Activity>, DialogStateManager>

Значение свойства

TemplateInterface<Partial<Activity>, DialogStateManager>

validations

Выражения, выполняемые для проверки входных данных.

validations: string[]

Значение свойства

string[]

value

Выражение значения, которое можно использовать для инициализации входного запроса.

value: ValueExpression

Значение свойства

ValueExpression

VALUE_PROPERTY 

static VALUE_PROPERTY: string

Значение свойства

string

Сведения об унаследованном свойстве

EndOfTurn

Возвращает результат конца по умолчанию.

static EndOfTurn: DialogTurnResult

Значение свойства

DialogTurnResult

Комментарии

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

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

id 

id: string

Значение свойства

string

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

telemetryClient 

telemetryClient: BotTelemetryClient

Значение свойства

BotTelemetryClient

наследуется от Dialog.telemetryClient

Сведения о методе

beginDialog(DialogContext, any)

Вызывается при запуске диалогового окна и отправке в стек диалогов.

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

Параметры

dc

DialogContext

DialogContext для текущей очереди беседы.

options

any

Необязательный. Начальные сведения для передачи в диалоговое окно .

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

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

Преобразователь конфигурации селектора.

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, представляющий асинхронную операцию.

Сведения о наследуемом методе

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"