com.slack.api.model.dialog

Class DialogSelectElement

java.lang.Object

com.slack.api.model.dialog.DialogSelectElement

All Implemented Interfaces:

DialogElement

public class DialogSelectElement
extends Object
implements DialogElement

Represents a select dialog element

Use the select element for multiple choice selections allowing users to pick a single item from a list. True to web roots, this selection is displayed as a dropdown menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DialogSelectElement.DialogSelectElementBuilder

Constructor Summary

Constructors

Constructor and Description
DialogSelectElement()
DialogSelectElement(String label, String name, String value, String placeholder, boolean optional, List<DialogOption> options)

Method Summary

Modifier and Type	Method and Description
static DialogSelectElement.DialogSelectElementBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getLabel() Label displayed to user.
String	getName() Name of form element.
List<DialogOption>	getOptions() Provide up to 100 option element attributes.
String	getPlaceholder() A string displayed as needed to help guide users in completing the element.
String	getType() Type of element.
String	getValue() A default value for this field.
int	hashCode()
boolean	isOptional() Provide true when the form element is not required.
void	setLabel(String label) Label displayed to user.
void	setName(String name) Name of form element.
void	setOptional(boolean optional) Provide true when the form element is not required.
void	setOptions(List<DialogOption> options) Provide up to 100 option element attributes.
void	setPlaceholder(String placeholder) A string displayed as needed to help guide users in completing the element.
void	setValue(String value) A default value for this field.
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DialogSelectElement

public DialogSelectElement()

DialogSelectElement

public DialogSelectElement(String label,
                           String name,
                           String value,
                           String placeholder,
                           boolean optional,
                           List<DialogOption> options)

Method Detail

builder

public static DialogSelectElement.DialogSelectElementBuilder builder()

getLabel

public String getLabel()

Label displayed to user. Required. No more than 24 characters.

Specified by:

getLabel in interface DialogElement

getName

public String getName()

Name of form element. Required. No more than 300 characters.

Specified by:

getName in interface DialogElement

getType

public String getType()

Type of element. For a dropdown (select), the type is always select . It's required.

Specified by:

getType in interface DialogElement

See Also:

Dialog form elements

getValue

public String getValue()

A default value for this field. Must match a value presented in DialogOptions.

Specified by:

getValue in interface DialogElement

getPlaceholder

public String getPlaceholder()

A string displayed as needed to help guide users in completing the element. 150 character maximum.

Specified by:

getPlaceholder in interface DialogElement

isOptional

public boolean isOptional()

Provide true when the form element is not required. By default, form elements are required.

Specified by:

isOptional in interface DialogElement

getOptions

public List<DialogOption> getOptions()

Provide up to 100 option element attributes. Required for this type.

setLabel

public void setLabel(String label)

Label displayed to user. Required. No more than 24 characters.

Specified by:

setLabel in interface DialogElement

setName

public void setName(String name)

Name of form element. Required. No more than 300 characters.

Specified by:

setName in interface DialogElement

setValue

public void setValue(String value)

A default value for this field. Must match a value presented in DialogOptions.

Specified by:

setValue in interface DialogElement

setPlaceholder

public void setPlaceholder(String placeholder)

A string displayed as needed to help guide users in completing the element. 150 character maximum.

Specified by:

setPlaceholder in interface DialogElement

setOptional

public void setOptional(boolean optional)

Provide true when the form element is not required. By default, form elements are required.

Specified by:

setOptional in interface DialogElement

setOptions

public void setOptions(List<DialogOption> options)

Provide up to 100 option element attributes. Required for this type.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

canEqual

protected boolean canEqual(Object other)

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object