ChoiceInput class

Ссылка

Пакет:: botbuilder-dialogs-adaptive

ChoiceInput — декларативные входные данные для сбора выборов от пользователя.

Extends: InputDialog

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

ChoiceInput(string, Partial<Activity> | string)

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

Свойства

$kind
choiceOptions	Дополнительные параметры, переданные в `ChoiceFactory` и используемые для настройки стиля выбора, отрисованного пользователю.
choices	Список вариантов представления пользователю.
defaultLocale	Запрашивает языковой стандарт по умолчанию, который должен быть распознан.
outputFormat	Управление форматом ответа (значением или индексом выбора).
recognizerOptions	Дополнительные параметры, переданные базовой функции `recognizeChoices()`.
style	Стиль вариантов "да" и "нет", отображаемых пользователю при появлении запроса.

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

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)	Вызывается, когда дочерний Диалоговое окно завершает свою очередь, возвращая элемент управления в это диалоговое окно.

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

ChoiceInput(string, Partial<Activity> | string)

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

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

Параметры

property: string

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

prompt: Partial<Activity> | string

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

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

$kind

static $kind: string

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

string

choiceOptions

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

choiceOptions?: ObjectExpression<ChoiceFactoryOptions>

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

ObjectExpression<ChoiceFactoryOptions>

choices

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

choices: ObjectExpression<ChoiceSet>

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

ObjectExpression<ChoiceSet>

defaultLocale

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

defaultLocale?: StringExpression

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

StringExpression

outputFormat

Управление форматом ответа (значением или индексом выбора).

outputFormat: EnumExpression<ChoiceOutputFormat>

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

EnumExpression<ChoiceOutputFormat>

recognizerOptions

Дополнительные параметры, переданные базовой функции recognizeChoices().

recognizerOptions?: ObjectExpression<FindChoicesOptions>

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

ObjectExpression<FindChoicesOptions>

style

Стиль вариантов "да" и "нет", отображаемых пользователю при появлении запроса.

style: EnumExpression<ListStyle>

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

EnumExpression<ListStyle>

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

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

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

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

См. также

унаследован от 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

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

ChoiceInput class

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

Свойства

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

Методы

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

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

ChoiceInput(string, Partial<Activity> | string)

Параметры

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

$kind

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

choiceOptions

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

choices

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

defaultLocale

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

outputFormat

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

recognizerOptions

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

style

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

Комментарии

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

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)

Параметры