ChoiceFactoryOptions Classe

  • Referência
Pacote:
com.microsoft.bot.dialogs.choices
Artefato Maven:
com.microsoft.bot:bot-dialogs:4.14.3
  • java.lang.Object
    • com.microsoft.bot.dialogs.choices.ChoiceFactoryOptions

public class ChoiceFactoryOptions

Contém opções de formatação para apresentar uma lista de opções.

Resumo do campo

Modificador e tipo Campo e descrição
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

Resumo do Construtor

Construtor Description
ChoiceFactoryOptions()

Cria opções padrão.
ChoiceFactoryOptions(ChoiceFactoryOptions options)

Clona outro objeto de opções e aplica os padrões, se necessário.
ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore)

Cria opções com os valores de formatação especificados.
ChoiceFactoryOptions(String withInlineSeparator, String withInlineOr, String withInlineOrMore, boolean withIncludeNumbers)

Inicializa uma nova instância da classe.

Resumo do método

Modificador e tipo Método e descrição
java.lang.Boolean getIncludeNumbers()

Obtém um valor que indica se as opções de estilo embutido e de lista serão prefixadas com o índice de escolha; como em "1.
java.lang.String getInlineOr()

Obtém o separador inserido entre as opções quando há apenas duas opções.
java.lang.String getInlineOrMore()

Obtém o separador inserido entre as duas últimas opções quando há mais de 2 opções.
java.lang.String getInlineSeparator()

Obtém o caractere usado para separar escolhas individuais quando há mais de duas opções.
void setIncludeNumbers(Boolean withIncludeNumbers)

Define o valor que indica se as opções de estilo embutido e de lista serão prefixadas com o índice de escolha.
void setInlineOr(String withInlineOr)

Define o separador inserido entre as opções quando há apenas duas opções.
void setInlineOrMore(String withInlineOrMore)

Define o separador inserido entre as duas últimas opções quando há mais de 2 opções.
void setInlineSeparator(String withSeperator)

Define o caractere usado para separar as escolhas individuais quando há mais de duas opções.

Métodos herdados de 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

Detalhes do campo

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

Detalhes do construtor

ChoiceFactoryOptions

public ChoiceFactoryOptions()

Cria opções padrão.

ChoiceFactoryOptions

public ChoiceFactoryOptions(ChoiceFactoryOptions options)

Clona outro objeto de opções e aplica os padrões, se necessário.

Parâmetros:

options - O objeto de opções a ser clonado.

ChoiceFactoryOptions

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

Cria opções com os valores de formatação especificados.

Parâmetros:

withInlineSeparator - O valor do seperador embutido.
withInlineOr - O valor embutido.
withInlineOrMore - O valor embutido ou mais.

ChoiceFactoryOptions

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

Inicializa uma nova instância da classe. Consulte o código no ConfirmPrompt para obter um exemplo de uso.

Parâmetros:

withInlineSeparator - O valor do seperador embutido.
withInlineOr - O valor embutido.
withInlineOrMore - O valor embutido ou mais.
withIncludeNumbers - Sinalizador que indica se os números devem ser incluídos como uma opção.

Detalhes do método

getIncludeNumbers

public Boolean getIncludeNumbers()

Obtém um valor que indica se as opções de estilo embutido e de lista serão prefixadas com o índice de escolha; como em "1. opção". Se for falso, o estilo de lista usará uma lista com marcadores. O valor padrão é true.

Retornos:

Se for falso, o estilo de lista usará uma lista com marcadores.

getInlineOr

public String getInlineOr()

Obtém o separador inserido entre as opções quando há apenas duas opções. O valor padrão é '" ou "'. Isso é opcional.

Retornos:

O separador inserido entre as opções quando há apenas duas opções.

getInlineOrMore

public String getInlineOrMore()

Obtém o separador inserido entre as duas últimas opções quando há mais de 2 opções. O valor padrão é "" ou "". Isso é opcional.

Retornos:

O separador inserido entre as duas últimas opções quando há mais de 2 opções.

getInlineSeparator

public String getInlineSeparator()

Obtém o caractere usado para separar escolhas individuais quando há mais de duas opções. O valor padrão é "", "". Isso é opcional.

Retornos:

O seperador.

setIncludeNumbers

public void setIncludeNumbers(Boolean withIncludeNumbers)

Define o valor que indica se as opções de estilo embutido e de lista serão prefixadas com o índice de escolha.

Parâmetros:

withIncludeNumbers - Se for falso, o estilo de lista usará uma lista com marcadores.

setInlineOr

public void setInlineOr(String withInlineOr)

Define o separador inserido entre as opções quando há apenas duas opções.

Parâmetros:

withInlineOr - O separador inserido entre as opções quando há apenas duas opções.

setInlineOrMore

public void setInlineOrMore(String withInlineOrMore)

Define o separador inserido entre as duas últimas opções quando há mais de 2 opções.

Parâmetros:

withInlineOrMore - O separador inserido entre as duas últimas opções quando há mais de 2 opções.

setInlineSeparator

public void setInlineSeparator(String withSeperator)

Define o caractere usado para separar as escolhas individuais quando há mais de duas opções.

Parâmetros:

withSeperator - O seperador.

Aplica-se a