CancelAllDialogsBase class

Пакет:

botbuilder-dialogs-adaptive

Базовый класс для API CancelAllDialogs .

Extends

Dialog<O>

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

CancelAllDialogsBase()	Инициализирует новый экземпляр класса CancelAllDialogsBase .
CancelAllDialogsBase(string, string, boolean)	Инициализирует новый экземпляр класса CancelAllDialogsBase .

Свойства

activityProcessed	Значение, указывающее, должно ли новое диалоговое окно обрабатывать действие.
disabled	Необязательное выражение, если имеет значение true, отключает это действие.
eventName	Выражение для имени события.
eventValue	Выражение для значения события.

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

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

Методы

beginDialog(DialogContext, O)	Вызывается при запуске диалогового окна и отправке в стек диалогов.
getConverter(Object)

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

configure(Record<string, unknown>)	Метод Fluent для настройки объекта.
continueDialog(DialogContext)	При переопределении в производном классе продолжает диалоговое окно.
endDialog(TurnContext, DialogInstance, DialogReason)	При переопределении в производном классе выполняет очистку диалогового окна до его завершения.
getVersion()	Закодированная строка, используемая для обнаружения изменений бота при повторном развертывании.
onDialogEvent(DialogContext, DialogEvent)	Вызывается при возникновении события с помощью DialogContext.emitEvent(), либо текущим диалогом, либо диалогом, запущенным текущим диалогом.
repromptDialog(TurnContext, DialogInstance)	При переопределении в производном классе повторно запрашивает пользователя для ввода данных.
resumeDialog(DialogContext, DialogReason, any)	При переопределении в производном классе возобновляет диалоговое окно после завершения диалога над ним в стеке.

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

CancelAllDialogsBase()

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

new CancelAllDialogsBase()

CancelAllDialogsBase(string, string, boolean)

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

new CancelAllDialogsBase(eventName: string, eventValue?: string, isCancelAll?: boolean)

Параметры

eventName

string

Выражение для имени события.

eventValue

string

Необязательный элемент. Выражение для значения события.

isCancelAll

boolean

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

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

activityProcessed

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

activityProcessed: BoolExpression

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

BoolExpression

disabled

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

disabled: BoolExpression

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

BoolExpression

eventName

Выражение для имени события.

eventName: StringExpression

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

StringExpression

eventValue

Выражение для значения события.

eventValue: ValueExpression

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

ValueExpression

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

EndOfTurn

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

static EndOfTurn: DialogTurnResult

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

DialogTurnResult

Комментарии

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

Наследуется от Dialog.EndOfTurn

id

id: string

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

string

Наследуется от Dialog.id

telemetryClient

telemetryClient: BotTelemetryClient

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

BotTelemetryClient

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

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

beginDialog(DialogContext, O)

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

function beginDialog(dc: DialogContext, _options: O): Promise<DialogTurnResult>

Параметры

dc

DialogContext

DialogContext для текущего диалога.

_options

O

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

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

Promise<DialogTurnResult>

Promise, представляющий асинхронную операцию.

getConverter(Object)

function getConverter(property: Object): Converter | ConverterFactory

Параметры

property

Object

Ключ конфигурации условного селектора.

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

Converter | ConverterFactory

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

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

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

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

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

Promise<DialogTurnResult>

Обещание, разрешающееся в результатах поворота диалогового окна.

Комментарии

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

DialogContext вызывает этот метод при продолжении диалога.

Чтобы сообщить контексту диалога о завершении этого диалога, перед выходом из этого метода дождитесь dialogContext.endDialog .

См. также:

• DialogContext.continueDialog

Наследуется от Dialog.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

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

Комментарии

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

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

Наследуется от 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 вызывает этот метод, если текущий диалог должен повторно запрашивать входные данные от пользователя. Этот метод реализуется для диалоговых окон с запросами.

См. также:

• DialogContext.repromptDialog
• Командная строка.

Наследуется от Dialog.repromptDialog

resumeDialog(DialogContext, DialogReason, any)

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

function resumeDialog(dc: DialogContext, reason: DialogReason, result?: any): Promise<DialogTurnResult>

Параметры

dc

DialogContext

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

reason

DialogReason

Причина возобновления диалога. Обычно это DialogReason.endCalled.

result

any

Необязательный элемент. Возвращаемое значение, если таковое имеется, из оконченного диалогового окна.

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

Promise<DialogTurnResult>

Обещание, разрешающееся в результатах поворота диалогового окна.

Комментарии

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

DialogContext вызывает этот метод при возобновлении диалога. Если в предыдущем диалоговом окне в стеке возвращалось значение, это значение находится в параметре result .

Чтобы запустить дочерний диалог, используйте DialogContext.beginDialog или DialogContext.prompt; однако это не обязательно будет диалог, который запускает дочерний диалог. Чтобы сообщить контексту диалога о завершении этого диалога, перед выходом из этого метода дождитесь dialogContext.endDialog .

См. также:

• DialogContext.endDialog

Наследуется от Dialog.resumeDialog