ChoiceFactory Класс

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

public final class ChoiceFactory

Помогает отформатировать действие сообщения, содержащее список вариантов.

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

Модификатор и тип Метод и описание
static Activity forChannel(String channelId, List<Choice> list, String text)

Создает действие, включающее список вариантов, отформатированных на основе возможностей заданного канала.
static Activity forChannel(String channelId, List<Choice> list, String text, String speak, ChoiceFactoryOptions options)

Создает действие, включающее список вариантов, отформатированных на основе возможностей заданного канала.
static Activity heroCard(List<Choice> choices)

Создает действие с карточкой "Герой"на основе списка вариантов.
static Activity heroCard(List<Choice> choices, String text)

Создает действие с карточкой "Герой"на основе списка вариантов.
static Activity heroCard(List<Choice> choices, String text, String speak)

Создает действие с карточкой "Герой"на основе списка вариантов.
static Activity inline(List<Choice> choices, String text)

Создает действие, включающее список вариантов, отформатированных как встроенный список.
static Activity inline(List<Choice> choices, String text, String speak, ChoiceFactoryOptions options)

Создает действие, включающее список вариантов, отформатированных как встроенный список.
static Activity list(List<Choice> choices)

Создает действие сообщения, включающее список вариантов, форматированных как нумерованный или маркированный список.
static Activity list(List<Choice> choices, String text)

Создает действие сообщения, включающее список вариантов, форматированных как нумерованный или маркированный список.
static Activity list(List<Choice> choices, String text, String speak, ChoiceFactoryOptions options)

Создает действие сообщения, включающее список вариантов, форматированных как нумерованный или маркированный список.
static Activity listFromStrings(List<String> choices)

Создает действие сообщения, включающее список вариантов, форматированных как нумерованный или маркированный список.
static Activity listFromStrings(List<String> choices, String text, String speak, ChoiceFactoryOptions options)

Создает действие сообщения, включающее список вариантов, форматированных как нумерованный или маркированный список.
static Activity suggestedAction(List<Choice> choices)

Создает действие, включающее список действий карточки.
static Activity suggestedAction(List<Choice> choices, String text)

Создает действие, включающее список действий карточки.
static Activity suggestedAction(List<Choice> choices, String text, String speak)

Создает действие, включающее список действий карточки.
static Activity suggestedActionFromStrings(List<String> choices)

Создает действие, включающее список действий карточки.
static Activity suggestedActionFromStrings(List<String> choices, String text, String speak)

Создает действие, включающее список действий карточки.
static java.util.List<Choice> toChoices(String[] choices)

Возвращает список строк в виде списка вариантов.
static java.util.List<Choice> toChoices(List<String> choices)

Возвращает список строк в виде списка вариантов.

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

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

forChannel

public static Activity forChannel(String channelId, List list, String text)

Создает действие, включающее список вариантов, отформатированных на основе возможностей заданного канала.

Параметры:

channelId - Идентификатор канала. Класс Connector.Channel содержит известные идентификаторы каналов.
list - Список вариантов включения.
text - Текст отправленного сообщения. Может иметь значение NULL.

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

Созданное действие

forChannel

public static Activity forChannel(String channelId, List list, String text, String speak, ChoiceFactoryOptions options)

Создает действие, включающее список вариантов, отформатированных на основе возможностей заданного канала.

Параметры:

channelId - Идентификатор канала. Класс Connector.Channel содержит известные идентификаторы каналов.
list - Список вариантов включения.
text - Текст отправленного сообщения. Может иметь значение NULL.
speak - Текст, который будет говорить бот в канале с поддержкой речи. Может иметь значение NULL.
options - Параметры форматирования, используемые при отрисовке в виде списка. Если значение NULL, используются параметры по умолчанию.

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

Созданное действие

heroCard

public static Activity heroCard(List choices)

Создает действие с помощью HeroCard на основе списка вариантов.

Параметры:

choices - Список вариантов включения.

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

Созданное действие.

heroCard

public static Activity heroCard(List choices, String text)

Создает действие с помощью HeroCard на основе списка вариантов.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.

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

Созданное действие.

heroCard

public static Activity heroCard(List choices, String text, String speak)

Создает действие с помощью HeroCard на основе списка вариантов.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.
speak - Текст, который будет говорить бот в канале с поддержкой речи.

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

Созданное действие.

inline

public static Activity inline(List choices, String text)

Создает действие, включающее список вариантов, отформатированных как встроенный список.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения. Может иметь значение NULL.

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

Созданное действие.

inline

public static Activity inline(List choices, String text, String speak, ChoiceFactoryOptions options)

Создает действие, включающее список вариантов, отформатированных как встроенный список.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения. Может иметь значение NULL.
speak - Текст, который будет говорить бот в канале с поддержкой речи. Cab be null.
options - Параметры форматирования, используемые при отрисовке в виде списка. Может иметь значение NULL.

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

Созданное действие.

list

public static Activity list(List choices)

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

Параметры:

choices - Список вариантов включения.

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

Созданное действие.

list

public static Activity list(List choices, String text)

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

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.

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

Созданное действие.

list

public static Activity list(List choices, String text, String speak, ChoiceFactoryOptions options)

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

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.
speak - Текст, который будет говорить бот в канале с поддержкой речи.
options - Параметры форматирования, используемые при отрисовке в виде списка.

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

Созданное действие.

listFromStrings

public static Activity listFromStrings(List choices)

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

Параметры:

choices - Список строк, которые необходимо включить в качестве выбора.

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

Созданное действие.

listFromStrings

public static Activity listFromStrings(List choices, String text, String speak, ChoiceFactoryOptions options)

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

Параметры:

choices - Список строк, которые необходимо включить в качестве выбора.
text - Текст отправленного сообщения.
speak - Текст, который будет говорить бот в канале с поддержкой речи.
options - Параметры форматирования, используемые при отрисовке в виде списка.

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

Созданное действие.

suggestedAction

public static Activity suggestedAction(List choices)

Создает действие, включающее список действий карточки.

Параметры:

choices - Список вариантов включения.

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

Созданное действие.

suggestedAction

public static Activity suggestedAction(List choices, String text)

Создает действие, включающее список действий карточки.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.

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

Созданное действие.

suggestedAction

public static Activity suggestedAction(List choices, String text, String speak)

Создает действие, включающее список действий карточки.

Параметры:

choices - Список вариантов включения.
text - Текст отправленного сообщения.
speak - Текст, который будет говорить бот в канале с поддержкой речи.

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

Созданное действие.

suggestedActionFromStrings

public static Activity suggestedActionFromStrings(List choices)

Создает действие, включающее список действий карточки.

Параметры:

choices - Список строк, которые необходимо включить в качестве действий.

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

Созданное действие.

suggestedActionFromStrings

public static Activity suggestedActionFromStrings(List choices, String text, String speak)

Создает действие, включающее список действий карточки.

Параметры:

choices - Список строк, которые необходимо включить в качестве действий.
text - Текст отправленного сообщения.
speak - Текст, который будет говорить бот в канале с поддержкой речи.

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

Созданное действие.

toChoices

public static List toChoices(String[] choices)

Возвращает список строк в виде списка вариантов.

Параметры:

choices - Строки для преобразования.

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

Список вариантов.

toChoices

public static List toChoices(List choices)

Возвращает список строк в виде списка вариантов.

Параметры:

choices - Список строк для преобразования.

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

Список вариантов.

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