com.slack.api.model.block.element

Class MultiStaticSelectElement

java.lang.Object

com.slack.api.model.block.element.BlockElement

com.slack.api.model.block.element.MultiStaticSelectElement

public class MultiStaticSelectElement
extends BlockElement

https://api.slack.com/reference/block-kit/block-elements#multi_select

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	MultiStaticSelectElement.MultiStaticSelectElementBuilder

Field Summary

Fields

Modifier and Type	Field and Description
static String	TYPE

Constructor Summary

Constructors

Constructor and Description
MultiStaticSelectElement()
MultiStaticSelectElement(PlainTextObject placeholder, String actionId, List<OptionObject> options, List<OptionGroupObject> optionGroups, List<OptionObject> initialOptions, ConfirmationDialogObject confirm, Integer maxSelectedItems)

Method Summary

Modifier and Type	Method and Description
static MultiStaticSelectElement.MultiStaticSelectElementBuilder	builder()
protected boolean	canEqual(Object other)
boolean	equals(Object o)
String	getActionId() An identifier for the action triggered when a menu option is selected.
ConfirmationDialogObject	getConfirm() A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.
List<OptionObject>	getInitialOptions() An array of option objects that exactly match one or more of the options within options or option_groups.
Integer	getMaxSelectedItems() Specifies the maximum number of items that can be selected in the menu.
List<OptionGroupObject>	getOptionGroups() An array of option group objects.
List<OptionObject>	getOptions() An array of option objects.
PlainTextObject	getPlaceholder() A plain_text only text object that defines the placeholder text shown on the menu.
String	getType()
int	hashCode()
void	setActionId(String actionId) An identifier for the action triggered when a menu option is selected.
void	setConfirm(ConfirmationDialogObject confirm) A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.
void	setInitialOptions(List<OptionObject> initialOptions) An array of option objects that exactly match one or more of the options within options or option_groups.
void	setMaxSelectedItems(Integer maxSelectedItems) Specifies the maximum number of items that can be selected in the menu.
void	setOptionGroups(List<OptionGroupObject> optionGroups) An array of option group objects.
void	setOptions(List<OptionObject> options) An array of option objects.
void	setPlaceholder(PlainTextObject placeholder) A plain_text only text object that defines the placeholder text shown on the menu.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

TYPE

public static final String TYPE

See Also:

Constant Field Values

Constructor Detail

MultiStaticSelectElement

public MultiStaticSelectElement()

MultiStaticSelectElement

public MultiStaticSelectElement(PlainTextObject placeholder,
                                String actionId,
                                List<OptionObject> options,
                                List<OptionGroupObject> optionGroups,
                                List<OptionObject> initialOptions,
                                ConfirmationDialogObject confirm,
                                Integer maxSelectedItems)

Method Detail

builder

public static MultiStaticSelectElement.MultiStaticSelectElementBuilder builder()

getType

public String getType()

getPlaceholder

public PlainTextObject getPlaceholder()

A plain_text only text object that defines the placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.

getActionId

public String getActionId()

An identifier for the action triggered when a menu option is selected. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

getOptions

public List<OptionObject> getOptions()

An array of option objects. Maximum number of options is 100. If option_groups is specified, this field should not be.

NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

See Also:

The Pull request #103, A related discussion on StackOverFlow.com

getOptionGroups

public List<OptionGroupObject> getOptionGroups()

An array of option group objects. Maximum number of option groups is 100. If options is specified, this field should not be.

NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

See Also:

The Pull request #103, A related discussion on StackOverFlow.com

getInitialOptions

public List<OptionObject> getInitialOptions()

An array of option objects that exactly match one or more of the options within options or option_groups. These options will be selected when the menu initially loads.

getConfirm

public ConfirmationDialogObject getConfirm()

A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.

getMaxSelectedItems

public Integer getMaxSelectedItems()

Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.

setPlaceholder

public void setPlaceholder(PlainTextObject placeholder)

A plain_text only text object that defines the placeholder text shown on the menu. Maximum length for the text in this field is 150 characters.

setActionId

public void setActionId(String actionId)

An identifier for the action triggered when a menu option is selected. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids used elsewhere by your app. Maximum length for this field is 255 characters.

setOptions

public void setOptions(List<OptionObject> options)

An array of option objects. Maximum number of options is 100. If option_groups is specified, this field should not be.

NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

See Also:

The Pull request #103, A related discussion on StackOverFlow.com

setOptionGroups

public void setOptionGroups(List<OptionGroupObject> optionGroups)

An array of option group objects. Maximum number of option groups is 100. If options is specified, this field should not be.

NOTE: The reason I didn't initialize the List<> fields is because Slack (sometimes) gives errors when it encounters an empty list in the generated JSON. The proper solution if/when you don't want un-initialized fields is to have a Gson type adapter that skips empty lists

See Also:

The Pull request #103, A related discussion on StackOverFlow.com

setInitialOptions

public void setInitialOptions(List<OptionObject> initialOptions)

An array of option objects that exactly match one or more of the options within options or option_groups. These options will be selected when the menu initially loads.

setConfirm

public void setConfirm(ConfirmationDialogObject confirm)

A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.

setMaxSelectedItems

public void setMaxSelectedItems(Integer maxSelectedItems)

Specifies the maximum number of items that can be selected in the menu. Minimum number is 1.

toString

public String toString()

Overrides:

toString in class Object

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