DialogSet Класс

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

public class DialogSet

Коллекция объектов Диалогового окна, которые могут вызывать друг друга.

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

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

Создает диалоговое окноSet без состояния.
DialogSet(StatePropertyAccessor<DialogState> withDialogState)

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

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

Модификатор и тип Метод и описание
DialogSet add(Dialog dialog)

Добавляет новое диалоговое окно в набор и возвращает набор, позволяющий свободно цепочки.
java.util.concurrent.CompletableFuture<DialogContext> createContext(TurnContext turnContext)

Создает диалоговое окноконтекст, который можно использовать для работы с диалогами в диалоговомнаборе.
Dialog find(String dialogId)

Выполняет поиск текущего диалогового окназадания для диалогового окна по его идентификатору.
java.util.Collection<Dialog> getDialogs()

Возвращает коллекцию диалогов в этом диалоговом окнеSet.
BotTelemetryClient getTelemetryClient()

Возвращает клиент телеметрии ботателеметрии, используемый для ведения журнала.
java.lang.String getVersion()

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

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

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

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

DialogSet

public DialogSet()

Создает диалоговое окно без состояния.

DialogSet

public DialogSet(StatePropertyAccessor withDialogState)

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

Чтобы запустить и управлять диалогами в этом наборе диалогов, создайте диалоговое окно DialogContext и используйте его методы для запуска, продолжения или завершения диалогов. Чтобы создать контекст диалогового окна, вызовите createContext(TurnContext).

Параметры:

withDialogState - Метод доступа к свойству состояния, с помощью которого можно управлять стеком для этого набора диалогов.

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

add

public DialogSet add(Dialog dialog)

Добавляет новое диалоговое окно в набор и возвращает набор, позволяющий свободно цепочки. Если добавленный Dialog.Id уже существует в наборе, идентификатор диалогов будет обновлен, чтобы включить суффикс, который делает его уникальным. Таким образом, добавление 2 диалоговых окон с именем "дубликат" в набор приведет к тому, что первая из них имеет идентификатор "дубликата" и второй имеет идентификатор "дубликата2".

Параметры:

dialog - Диалоговое окно для добавления. Добавленное диалоговое окно Dialog.TelemetryClient имеет значение BotTelemetryClient набора диалоговых окон.

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

Диалоговое окно после завершения операции.

createContext

public CompletableFuture createContext(TurnContext turnContext)

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

Параметры:

turnContext - Контекст для текущего шага беседы с пользователем.

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

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

find

public Dialog find(String dialogId)

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

Параметры:

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

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

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

getDialogs

public Collection

getDialogs()

Возвращает коллекцию диалогов в этом диалоговом окне.

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

Диалоги в этом диалоговом окне.

getTelemetryClient

public BotTelemetryClient getTelemetryClient()

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

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

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

getVersion

public String getVersion()

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

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

Версия изменится при изменении любой из дочерних диалоговых окон.

setTelemetryClient

public void setTelemetryClient(BotTelemetryClient withBotTelemetryClient)

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

Если это свойство задано, он задает Dialog.TelemetryClient каждого диалогового окна в наборе для нового значения.

Параметры:

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

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