DialogContainer Класс

  • Ссылка
Пакет:
com.microsoft.bot.dialogs
Артефакт Maven:
com.microsoft.bot:bot-dialogs:4.14.3

public abstract class DialogContainer
extends Dialog

Контейнер для набора диалогов.

Сводка по конструктору

Конструктор Описание
DialogContainer()

Создает новый экземпляр с идентификатором диалогового окна по умолчанию.
DialogContainer(String dialogId)

Создает новый экземпляр с идентификатором диалогового окна по умолчанию.

Сводка по методу

Модификатор и тип Метод и описание
protected java.util.concurrent.CompletableFuture<java.lang.Void> checkForVersionChange(DialogContext dc)

Проверяет, изменились ли дочерние диалоги контейнеров с момента запуска текущего экземпляра диалогового окна.
abstract DialogContext createChildContext(DialogContext dc)

Создает внутренний контекст диалогового окна для активного дочернего контейнера.
Dialog findDialog(String dialogId)

Выполняет поиск текущего диалогового окназадания для диалогового окна по его идентификатору.
DialogSet getDialogs()

Возвращает диалоговые окна в виде диалогового окнанабор.
protected java.lang.String getInternalVersion()

Возвращает внутренний идентификатор версии для этого контейнера.
java.util.concurrent.CompletableFuture<java.lang.Boolean> onDialogEvent(DialogContext dc, DialogEvent e)

Вызывается при возникновении события с помощью диалогового окнаконтекста.выпустить событие()" либо текущим диалогом, либо диалогом, запущенным текущим диалогом.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

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

Методы, унаследованные от Dialog

beginDialog beginDialog continueDialog endDialog getId getTelemetryClient getVersion innerRun onComputeId onDialogEvent onPostBubbleEvent onPreBubbleEvent repromptDialog resumeDialog resumeDialog run setId setTelemetryClient

Методы, унаследованные от java.lang.Object

java.lang.Object.clone java.lang.Object.equals java.lang.Object.finalize java.lang.Object.getClass java.lang.Object.hashCode java.lang.Object.notify java.lang.Object.notifyAll java.lang.Object.toString java.lang.Object.wait java.lang.Object.wait java.lang.Object.wait

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

DialogContainer

public DialogContainer()

Создает новый экземпляр с идентификатором диалогового окна по умолчанию.

DialogContainer

public DialogContainer(String dialogId)

Создает новый экземпляр с идентификатором диалогового окна по умолчанию.

Параметры:

dialogId - Идентификатор диалогового окна.

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

checkForVersionChange

protected CompletableFuture checkForVersionChange(DialogContext dc)

Проверяет, изменились ли дочерние диалоги контейнеров с момента запуска текущего экземпляра диалогового окна. Это должно вызываться в начале "beginDialog()", "continueDialog()" и "resumeDialog()".

Параметры:

dc - Контекст диалогового окна

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

Завершениеfuture

createChildContext

public abstract DialogContext createChildContext(DialogContext dc)

Создает внутренний контекст диалогового окна для активного дочернего контейнера.

Параметры:

dc - Контекст диалогового окна "Родители".

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

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

findDialog

public Dialog findDialog(String dialogId)

Выполняет поиск текущего набора диалоговых окон для диалогового окна по его идентификатору.

Параметры:

dialogId - Идентификатор диалогового окна для поиска.

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

При обнаружении диалогового окна; в противном случае значение NULL

getDialogs

public DialogSet getDialogs()

Возвращает диалоговые окна в качестве набора диалогов.

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

Набор диалогов.

getInternalVersion

protected String getInternalVersion()

Возвращает внутренний идентификатор версии для этого контейнера.

DialogContainers обнаруживает изменения всех вложенных компонентов в контейнере и сопоставляет их с событием DialogChanged. Так как они делают это, DialogContainers "скрыть" внутренние изменения и просто иметь идентификатор .id. Это изолирует изменения на уровне контейнера, если контейнер не обрабатывает его. Для поддержки этого диалогового окнаContainers определите защищенный виртуальный метод getInternalVersion(), который вычисляет, если это диалоговое окно или дочерние диалоги изменились, которые затем проверяются с помощью вызовов checkForVersionChange().

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

версия, представляющая изменение внутренних компонентов этого контейнера.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

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

Это переопределение будет отслеживать изменения версии.

Переопределения:

DialogContainer.onDialogEvent(DialogContext dc, DialogEvent e)

Параметры:

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

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

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

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

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

Переопределения:

DialogContainer.setTelemetryClient(BotTelemetryClient withTelemetryClient)

Параметры:

withTelemetryClient - BotTelemetryClient, используемый для ведения журнала.

Применяется к