Package com.slack.api.model.block.element

Class MultiStaticSelectElement.MultiStaticSelectElementBuilder

java.lang.Object

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

Enclosing class:

MultiStaticSelectElement

public static class MultiStaticSelectElement.MultiStaticSelectElementBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
MultiStaticSelectElement.MultiStaticSelectElementBuilder	actionId(String actionId)	An identifier for the action triggered when a menu option is selected.
MultiStaticSelectElement	build()
MultiStaticSelectElement.MultiStaticSelectElementBuilder	confirm(ConfirmationDialogObject confirm)	A confirm object that defines an optional confirmation dialog that appears before the multi-select choices are submitted.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	focusOnLoad(Boolean focusOnLoad)	Indicates whether the element will be set to auto focus within the view object.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	initialOptions(List<OptionObject> initialOptions)	An array of option objects that exactly match one or more of the options within options or option_groups.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	maxSelectedItems(Integer maxSelectedItems)	Specifies the maximum number of items that can be selected in the menu.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	optionGroups(List<OptionGroupObject> optionGroups)	An array of option group objects.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	options(List<OptionObject> options)	An array of option objects.
MultiStaticSelectElement.MultiStaticSelectElementBuilder	placeholder(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, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

placeholder

public MultiStaticSelectElement.MultiStaticSelectElementBuilder placeholder(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.

Returns:

this.

actionId

public MultiStaticSelectElement.MultiStaticSelectElementBuilder actionId(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.

Returns:

this.

options

public MultiStaticSelectElement.MultiStaticSelectElementBuilder options(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

Returns:

this.

See Also:

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

optionGroups

public MultiStaticSelectElement.MultiStaticSelectElementBuilder optionGroups(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

Returns:

this.

See Also:

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

initialOptions

public MultiStaticSelectElement.MultiStaticSelectElementBuilder initialOptions(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.

Returns:

this.

confirm

public MultiStaticSelectElement.MultiStaticSelectElementBuilder confirm(ConfirmationDialogObject confirm)

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

Returns:

this.

maxSelectedItems

public MultiStaticSelectElement.MultiStaticSelectElementBuilder maxSelectedItems(Integer maxSelectedItems)

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

Returns:

this.

focusOnLoad

public MultiStaticSelectElement.MultiStaticSelectElementBuilder focusOnLoad(Boolean focusOnLoad)

Indicates whether the element will be set to auto focus within the view object. Only one element can be set to true. Defaults to false.

Returns:

this.

build

public MultiStaticSelectElement build()

toString

public String toString()

Overrides:

toString in class Object