Dialog Класс

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

public abstract class Dialog

Базовый класс для всех диалоговых окон.

Сводка по полю

Модификатор и тип Поле и описание
static final DialogTurnResult END_OF_TURN

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

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

Конструктор Описание
Dialog(String dialogId)

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

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

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

Вызывается при запуске диалогового окна и отправке в стек диалогов.
abstract java.util.concurrent.CompletableFuture<DialogTurnResult> beginDialog(DialogContext dc, Object options)

Вызывается при запуске диалогового окна и отправке в стек диалогов.
java.util.concurrent.CompletableFuture<DialogTurnResult> continueDialog(DialogContext dc)

Вызывается при выполнении диалогового окна _continued_, где он является активным диалогом, а пользователь отвечает с новым действием.
java.util.concurrent.CompletableFuture<java.lang.Void> endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Вызывается, когда диалоговое окно заканчивается.
java.lang.String getId()

Возвращает идентификатор диалогового окна.
BotTelemetryClient getTelemetryClient()

Возвращает BotTelemetryClient для ведения журнала.
java.lang.String getVersion()

Возвращает уникальную строку, представляющую версию этого диалогового окна.
protected static java.util.concurrent.CompletableFuture<DialogTurnResult> innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Общая реализация запуска с помощью диалогового окна и диалогового окнаManager.
protected java.lang.String onComputeId()

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

Вызывается при возникновении события с помощью диалогового окнаконтекста.выпустить событие()" либо текущим диалогом, либо диалогом, запущенным текущим диалогом.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPostBubbleEvent(DialogContext dc, DialogEvent e)

Вызывается после того, как событие было пузырьки для всех родителей и не было обработано.
protected java.util.concurrent.CompletableFuture<java.lang.Boolean> onPreBubbleEvent(DialogContext dc, DialogEvent e)

Вызывается перед тем, как событие будет перемыкаться в родительский объект.
java.util.concurrent.CompletableFuture<java.lang.Void> repromptDialog(TurnContext turnContext, DialogInstance instance)

Вызывается, когда диалоговое окно должно повторно запрашивать ввод пользователем.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason)

Вызывается, когда дочернее диалоговое окно завершило этот поворот, возвращая элемент управления в это диалоговое окно.
java.util.concurrent.CompletableFuture<DialogTurnResult> resumeDialog(DialogContext dc, DialogReason reason, Object result)

Вызывается, когда дочернее диалоговое окно завершило этот поворот, возвращая элемент управления в это диалоговое окно.
static java.util.concurrent.CompletableFuture<java.lang.Void> run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor<DialogState> accessor)

Создает стек диалогов и запускает диалоговое окно, принудив его к стеку.
void setId(String withId)

Задает идентификатор диалогового окна.
void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Задает BotTelemetryClient для ведения журнала.

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

Сведения о полях

END_OF_TURN

public static final DialogTurnResult END_OF_TURN

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

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

Dialog

public Dialog(String dialogId)

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

Параметры:

dialogId - Идентификатор, назначенный этому диалогу.

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

beginDialog

public CompletableFuture beginDialog(DialogContext dc)

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

Параметры:

dc - DialogContext для текущего поворота беседы.

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

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

beginDialog

public abstract CompletableFuture beginDialog(DialogContext dc, Object options)

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

Параметры:

dc - DialogContext для текущего поворота беседы.
options - Начальные сведения для передачи в диалоговое окно.

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

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

continueDialog

public CompletableFuture continueDialog(DialogContext dc)

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

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

Параметры:

dc - DialogContext для текущего поворота беседы.

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

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

endDialog

public CompletableFuture endDialog(TurnContext turnContext, DialogInstance instance, DialogReason reason)

Вызывается, когда диалоговое окно заканчивается.

Параметры:

turnContext - Объект контекста для этого поворота.
instance - Сведения о состоянии, связанные с экземпляром этого диалогового окна в стеке диалогов.
reason - Причина, по которой диалоговое окно закончилось.

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

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

getId

public String getId()

Возвращает идентификатор диалогового окна.

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

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

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

Возвращает BotTelemetryClient для ведения журнала.

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

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

getVersion

public String getVersion()

Возвращает уникальную строку, представляющую версию этого диалогового окна. Если изменение версии между поворотами диалоговой системы приведет к возникновению события DialogChanged.

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

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

innerRun

protected static CompletableFuture innerRun(TurnContext turnContext, String dialogId, DialogContext dialogContext, DialogStateManagerConfiguration stateConfiguration)

Общая реализация запуска с помощью Диалогового окна и DialogManager.

Параметры:

turnContext - TurnContext.
dialogId - Идентификатор диалогового окна.
dialogContext - The DialogContext.
stateConfiguration - The DialogStateManagerConfiguration.

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

Диалоговое окно DialogTurnResult.

onComputeId

protected String onComputeId()

Вычисляет идентификатор диалогового окна.

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

Идентификатор.

onDialogEvent

public CompletableFuture onDialogEvent(DialogContext dc, DialogEvent e)

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

Параметры:

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

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

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

onPostBubbleEvent

protected CompletableFuture onPostBubbleEvent(DialogContext dc, DialogEvent e)

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

Это хорошее место для выполнения логики обработки по умолчанию для события. При возврате "true" не удастся обработать событие дочерними диалогами.

Параметры:

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

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

Должно ли событие обрабатываться текущим диалогом и дальнейшей обработкой.

onPreBubbleEvent

protected CompletableFuture onPreBubbleEvent(DialogContext dc, DialogEvent e)

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

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

Параметры:

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

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

Должно ли событие обрабатываться текущим диалогом и дальнейшей обработкой.

repromptDialog

public CompletableFuture repromptDialog(TurnContext turnContext, DialogInstance instance)

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

Параметры:

turnContext - Объект контекста для этого поворота.
instance - Сведения о состоянии этого диалогового окна.

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

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

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason)

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

Как правило, дочерний диалог был запущен с вызовом beginDialog(DialogContext dc, Object options) Однако, если вызывается метод replaceDialog(String dialogId), логический дочерний диалог может отличаться от исходного.

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

Параметры:

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

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

Если задача выполнена успешно, результат указывает, активен ли этот диалог после обработки этого диалогового окна.

resumeDialog

public CompletableFuture resumeDialog(DialogContext dc, DialogReason reason, Object result)

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

Как правило, дочерний диалог был запущен с вызовом beginDialog(DialogContext dc, Object options) Однако, если вызывается метод replaceDialog(String dialogId, Object options), логический дочерний диалог может отличаться от исходного.

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

Параметры:

dc - Контекст диалогового окна для текущей очереди беседы.
reason - Причина возобновления диалога.
result - Необязательное значение, возвращаемое из вызываемого диалогового окна. Тип возвращаемого значения зависит от дочернего диалогового окна.

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

Если задача выполнена успешно, результат указывает, активен ли этот диалог после обработки этого диалогового окна.

run

public static CompletableFuture run(Dialog dialog, TurnContext turnContext, StatePropertyAccessor accessor)

Создает стек диалогов и запускает диалоговое окно, принудив его к стеку.

Параметры:

dialog - Диалоговое окно для запуска.
turnContext - Контекст для текущей очереди беседы.
accessor - Метод доступа StatePropertyAccessor, с помощью которого можно управлять состоянием стека диалогов.

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

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

setId

public void setId(String withId)

Задает идентификатор диалогового окна.

Параметры:

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

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withTelemetryClient)

Задает BotTelemetryClient для ведения журнала.

Параметры:

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

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