ChoiceFactoryOptions Класс

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

public class ChoiceFactoryOptions

Содержит параметры форматирования для представления списка вариантов.

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

Модификатор и тип Поле и описание
static final boolean DEFAULT_INCLUDE_NUMBERS
static final java.lang.String DEFAULT_INLINE_OR
static final java.lang.String DEFAULT_INLINE_OR_MORE
static final java.lang.String DEFAULT_INLINE_SEPERATOR

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

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

Создает параметры по умолчанию.
ChoiceFactoryOptions(ChoiceFactoryOptions options)

Клонирует другой объект параметров и применяет значения по умолчанию при необходимости.
ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore)

Создает параметры с указанными значениями форматирования.
ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore, boolean withIncludeNumbers)

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

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

Модификатор и тип Метод и описание
java.lang.Boolean getIncludeNumbers()

Возвращает значение, указывающее, будет ли выбор стиля встроенных и списков префиксирован с помощью индекса выбора; как в "1.
java.lang.String getInlineOr()

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

Получает разделитель, вставленный между последними 2 вариантами, если имеется более 2 вариантов.
java.lang.String getInlineSeparator()

Получает символ, используемый для разделения отдельных вариантов выбора, если есть более 2 вариантов.
void setIncludeNumbers(Boolean withIncludeNumbers)

Задает значение, указывающее, будет ли выбор стиля встроенных и списков префиксирован индексом выбора.
void setInlineOr(String withInlineOr)

Задает разделитель, вставленный между вариантами, если есть только 2 варианта.
void setInlineOrMore(String withInlineOrMore)

Задает разделитель, вставленный между последними 2 вариантами при наличии более 2 вариантов.
void setInlineSeparator(String withSeperator)

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

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

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

DEFAULT_INCLUDE_NUMBERS

public static final boolean DEFAULT_INCLUDE_NUMBERS

DEFAULT_INLINE_OR

public static final String DEFAULT_INLINE_OR

DEFAULT_INLINE_OR_MORE

public static final String DEFAULT_INLINE_OR_MORE

DEFAULT_INLINE_SEPERATOR

public static final String DEFAULT_INLINE_SEPERATOR

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

ChoiceFactoryOptions

public ChoiceFactoryOptions()

Создает параметры по умолчанию.

ChoiceFactoryOptions

public ChoiceFactoryOptions(ChoiceFactoryOptions options)

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

Параметры:

options - Объект options для клонирования.

ChoiceFactoryOptions

public ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore)

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

Параметры:

withInlineSeparator - Значение встроенного разделителя.
withInlineOr - Встроенное или значение.
withInlineOrMore - Встроенное или большее значение.

ChoiceFactoryOptions

public ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore, boolean withIncludeNumbers)

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

Параметры:

withInlineSeparator - Значение встроенного разделителя.
withInlineOr - Встроенное или значение.
withInlineOrMore - Встроенное или большее значение.
withIncludeNumbers - Флаг, указывающий, следует ли включать числа в качестве выбора.

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

getIncludeNumbers

public Boolean getIncludeNumbers()

Возвращает значение, указывающее, будет ли выбор стиля встроенных и списков префиксирован с помощью индекса выбора; как в "1. выбор". Если значение false, стиль списка будет использовать маркированный список. Значение по умолчанию — true.

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

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

getInlineOr

public String getInlineOr()

Возвращает разделитель, вставленный между вариантами, если есть только 2 варианта. Значение по умолчанию — "" или "". Это необязательно.

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

Разделитель, вставленный между вариантами, если есть только 2 варианта.

getInlineOrMore

public String getInlineOrMore()

Получает разделитель, вставленный между последними 2 вариантами, если имеется более 2 вариантов. Значение по умолчанию — "", "" или "". Это необязательно.

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

Разделитель, вставленный между последними 2 вариантами при наличии более 2 вариантов.

getInlineSeparator

public String getInlineSeparator()

Получает символ, используемый для разделения отдельных вариантов выбора, если есть более 2 вариантов. Значение по умолчанию — "", "". Это необязательно.

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

Сеператор.

setIncludeNumbers

public void setIncludeNumbers(Boolean withIncludeNumbers)

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

Параметры:

withIncludeNumbers - Если значение false, стиль списка будет использовать маркированный список.

setInlineOr

public void setInlineOr(String withInlineOr)

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

Параметры:

withInlineOr - Разделитель, вставленный между вариантами, если есть только 2 варианта.

setInlineOrMore

public void setInlineOrMore(String withInlineOrMore)

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

Параметры:

withInlineOrMore - Разделитель, вставленный между последними 2 вариантами при наличии более 2 вариантов.

setInlineSeparator

public void setInlineSeparator(String withSeperator)

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

Параметры:

withSeperator - Сеператор.

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