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

Class CheckboxesElement.CheckboxesElementBuilder

java.lang.Object

com.slack.api.model.block.element.CheckboxesElement.CheckboxesElementBuilder

Enclosing class:

CheckboxesElement

public static class CheckboxesElement.CheckboxesElementBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
CheckboxesElement.CheckboxesElementBuilder	actionId(String actionId)	An identifier for the action triggered when the checkbox group is changed.
CheckboxesElement	build()
CheckboxesElement.CheckboxesElementBuilder	confirm(ConfirmationDialogObject confirm)	A confirm object that defines an optional confirmation dialog that appears after clicking one of the checkboxes in this element.
CheckboxesElement.CheckboxesElementBuilder	focusOnLoad(Boolean focusOnLoad)	Indicates whether the element will be set to auto focus within the view object.
CheckboxesElement.CheckboxesElementBuilder	initialOptions(List<OptionObject> initialOptions)	An array of option objects that exactly matches one or more of the options within options.
CheckboxesElement.CheckboxesElementBuilder	options(List<OptionObject> options)	An array of option objects.
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Details

actionId

public CheckboxesElement.CheckboxesElementBuilder actionId(String actionId)

An identifier for the action triggered when the checkbox group is changed. 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 CheckboxesElement.CheckboxesElementBuilder options(List<OptionObject> options)

An array of option objects.

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 CheckboxesElement.CheckboxesElementBuilder initialOptions(List<OptionObject> initialOptions)

An array of option objects that exactly matches one or more of the options within options. These options will be selected when the checkbox group initially loads.

Returns:

this.

confirm

public CheckboxesElement.CheckboxesElementBuilder confirm(ConfirmationDialogObject confirm)

A confirm object that defines an optional confirmation dialog that appears after clicking one of the checkboxes in this element.

Returns:

this.

focusOnLoad

public CheckboxesElement.CheckboxesElementBuilder 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 CheckboxesElement build()

toString

public String toString()

Overrides:

toString in class Object