DialogContext Класс

Ссылка

Пакет:: com.microsoft.bot.dialogs

Артефакт Maven:: com.microsoft.bot:bot-dialogs:4.14.3

java.lang.Object
- com.microsoft.bot.dialogs.DialogContext

public class DialogContext

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

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

Конструктор	Описание
DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)	Инициализирует новый экземпляр класса DialogContext из контекста поворота.
DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)	Инициализирует новый экземпляр класса DialogContext из контекста поворота.

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

Модификатор и тип	Метод и описание
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId) Запускает новый диалог и отправляет его в стек диалогов.
java.util.concurrent.CompletableFuture<DialogTurnResult>	beginDialog(String dialogId, Object options) Запускает новый диалог и отправляет его в стек диалогов.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs() Вспомогательный метод для cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue), который не отменяет родительские диалоги или передает и событие.
java.util.concurrent.CompletableFuture<DialogTurnResult>	cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue) Удаляет любой существующий стек диалогов, поэтому отменяя все диалоговые окна в стеке.
java.util.concurrent.CompletableFuture<DialogTurnResult>	continueDialog() Продолжает выполнение активного диалогового окна, если он есть, передав текущий диалогконтекст в метод continueDialog(DialogContext dc) активного диалога.
java.util.concurrent.CompletableFuture<java.lang.Boolean>	emitEvent(String name)
java.util.concurrent.CompletableFuture<java.lang.Boolean>	emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)
java.util.concurrent.CompletableFuture<DialogTurnResult>	endDialog() Вспомогательный метод, предоставляющий пустой результат для endDialog(Object result).
java.util.concurrent.CompletableFuture<DialogTurnResult>	endDialog(Object result) Завершает диалоговое окно, открыв его из стека и возвращает необязательный результат родительскому диалогу.
Dialog	findDialog(String dialogId) Найдите идентификатор диалогового окна для заданного контекста.
DialogInstance	getActiveDialog() Возвращает кэшированный экземпляр активного диалогового окна в верхней части стека или null, если стек пуст.
DialogContext	getChild() Возвращает контекст диалогового окна для дочернего элемента, если имеется активный дочерний элемент.
TurnContext	getContext() Возвращает контекст для текущей очереди беседы.
DialogSet	getDialogs() Возвращает набор диалогов, которые активны для текущего контейнера диалогов.
java.lang.String	getLocale() Получите языковой стандарт в диалоговом окнеконтексте.
DialogContext	getParent() Возвращает родительское диалоговое окноконтекст, если таковой есть.
TurnContextStateCollection	getServices() Возвращает коллекцию служб, которая является контекстной для этого контекста диалога.
java.util.List<DialogInstance>	getStack() Возвращает текущий стек диалогов.
DialogStateManager	getState() Возвращает или задает диспетчер состояниядиалогового окна, который управляет представлением всех областей памяти.
java.util.concurrent.CompletableFuture<DialogTurnResult>	prompt(String dialogId, PromptOptions options) Вспомогательные функции для упрощения форматирования параметров вызова диалогового окна запроса.
java.util.concurrent.CompletableFuture<DialogTurnResult>	replaceDialog(String dialogId) Вспомогательный метод для replaceDialog(String dialogId, Object options), который передает значение NULL для параметров.
java.util.concurrent.CompletableFuture<DialogTurnResult>	replaceDialog(String dialogId, Object options) Запускает новое диалоговое окно и заменяет в стеке активное диалоговое окно новым.
java.util.concurrent.CompletableFuture<java.lang.Void>	repromptDialog() Вызывает метод repromptDialog(TurnContext turnContext, DialogInstance instance) текущего диалогового окна.
void	setParent(DialogContext withDialogContext) Задайте родительский диалогконтекст.

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

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

DialogContext

public DialogContext(DialogSet withDialogs, TurnContext withTurnContext, DialogState withState)

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

Параметры:

withDialogs - Диалоговое окно, для создания контекста диалогового окна.

withTurnContext - Текущий контекст поворота.

withState - Свойство состояния, из которого извлекается контекст диалога.

DialogContext

public DialogContext(DialogSet withDialogs, DialogContext withParentDialogContext, DialogState withState)

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

Параметры:

withDialogs - Диалоговое окно, для создания контекста диалогового окна.

withParentDialogContext - Контекст родительского диалогового окна.

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

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

beginDialog

public CompletableFuture beginDialog(String dialogId)

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

Параметры:

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

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

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

beginDialog

public CompletableFuture beginDialog(String dialogId, Object options)

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

Параметры:

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

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

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

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

cancelAllDialogs

public CompletableFuture cancelAllDialogs()

Вспомогательный метод для cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue), который не отменяет родительские диалоги или передает и событие.

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

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

cancelAllDialogs

public CompletableFuture cancelAllDialogs(boolean cancelParents, String eventName, Object eventValue)

Удаляет любой существующий стек диалогов, поэтому отменяя все диалоговые окна в стеке.

Как правило, родительский контекст — это обработчик диалога или обработчик поворота бота, который запустил диалоговое окно. Если родительский элемент является диалогом, стек вызывает метод resumeDialog(DialogContext dc, DialogReason reason, Object result) родительского элемента, чтобы вернуть результат родительскому диалогу. Если родительское диалоговое окно не реализует Dialog#resumeDialog, то родительский элемент также завершится и результат передается следующему родительскому контексту.

Параметры:

cancelParents - Если значение true, отмена будет перемыкаться через любые родительские диалоги, а также.

eventName - Событие. Если значение NULL, используется CANCEL_DIALOG.

eventValue - Значение события. Может иметь значение NULL.

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

continueDialog

public CompletableFuture continueDialog()

Продолжает выполнение активного диалогового окна, если он есть, передав текущий dialogContext методу continueDialog(DialogContext dc) диалогового окна.

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

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

emitEvent

public CompletableFuture emitEvent(String name)

Параметры:

name - Имя создаваемого события.

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

emitEvent

public CompletableFuture emitEvent(String name, Object value, boolean bubble, boolean fromLeaf)

Параметры:

name - Имя создаваемого события.

value - Значение для отправки вместе с событием.

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

fromLeaf - Указывает, генерируется ли событие конечным узлом.

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

completedFuture

endDialog

public CompletableFuture endDialog()

Вспомогательный метод, предоставляющий пустой результат для endDialog(Object result).

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

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

endDialog

public CompletableFuture endDialog(Object result)

Завершает диалоговое окно, открыв его из стека и возвращает необязательный результат родительскому диалогу. Родительское диалоговое окно — это диалоговое окно начала завершения с помощью вызова beginDialog(String dialogId, Object options) или prompt(String dialogId, PromptOptions options). Родительское диалоговое окно будет вызывать метод resumeDialog(DialogContext dc, DialogReason reason, Object result) с любым возвращаемым результатом. Если родительское диалоговое окно не реализовало метод resumeDialog(DialogContext dc, DialogReason reason), оно будет автоматически завершено, а результат передается родительскому элементу. Если в стеке больше нет родительских диалогов, обработка поворота завершится.

Параметры:

result - Необязательный результат для передачи родительскому контексту.

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

findDialog

public Dialog findDialog(String dialogId)

Найдите идентификатор диалогового окна для заданного контекста.

Параметры:

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

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

диалоговое окно с этим идентификатором или null.

getActiveDialog

public DialogInstance getActiveDialog()

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

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

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

getChild

public DialogContext getChild()

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

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

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

getContext

public TurnContext getContext()

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

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

Контекст для текущего шага беседы.

getDialogs

public DialogSet getDialogs()

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

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

Набор диалогов, которые активны для текущего контейнера диалогов.

getLocale

public String getLocale()

Получите языковой стандарт в DialogContext.

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

Строка, представляющая текущий языковой стандарт.

getParent

public DialogContext getParent()

Возвращает родительский dialogContext, если таковой есть. Используется при поиске идентификатора диалогового окна для запуска.

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

Родительский элемент "DialogContext, если таковой есть. Используется при поиске идентификатора диалогового окна для запуска.

getServices

public TurnContextStateCollection getServices()

Возвращает коллекцию служб, которая является контекстной для этого контекста диалога.

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

Коллекция служб.

getStack

public List getStack()

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

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

Текущий стек диалогов.

getState

public DialogStateManager getState()

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

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

DialogStateManager с унифицированным представлением памяти всех областей памяти.

prompt

public CompletableFuture prompt(String dialogId, PromptOptions options)

Вспомогательные функции для упрощения форматирования параметров вызова диалогового окна запроса. Этот вспомогательный параметр примет аргумент PromptOptions, а затем вызовет beginDialog(String dialogId, Object options)

Параметры:

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

options - Сведения для передачи в запущенный диалог запроса.

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

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

replaceDialog

public CompletableFuture replaceDialog(String dialogId)

Вспомогательный метод для replaceDialog(String dialogId, Object options), который передает значение NULL для параметров.

Параметры:

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

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

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

replaceDialog

public CompletableFuture replaceDialog(String dialogId, Object options)

Запускает новое диалоговое окно и заменяет в стеке активное диалоговое окно новым. Это особенно полезно для создания циклов или перенаправления в другое диалоговое окно.

Параметры:

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

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

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

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

repromptDialog

public CompletableFuture repromptDialog()

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

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

Задача, представляющая выполняемую рабочую очередь.

setParent

public void setParent(DialogContext withDialogContext)

Задайте родительский dialogContext.

Параметры:

withDialogContext - DialogContext, для задания родительского значения.

DialogContext Класс

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

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

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

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

DialogContext

DialogContext

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

beginDialog

beginDialog

cancelAllDialogs

cancelAllDialogs

continueDialog

emitEvent

emitEvent

endDialog

endDialog

findDialog

getActiveDialog

getChild

getContext

getDialogs

getLocale

getParent

getServices

getStack

getState

prompt

replaceDialog

replaceDialog

repromptDialog

setParent

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