com.slack.api.model.block.element.CheckboxesElement Maven / Gradle / Ivy
package com.slack.api.model.block.element;
import com.slack.api.model.block.composition.ConfirmationDialogObject;
import com.slack.api.model.block.composition.OptionObject;
import lombok.*;
import java.util.List;
/**
* https://api.slack.com/reference/block-kit/block-elements#checkboxes
*/
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = false)
public class CheckboxesElement extends BlockElement {
public static final String TYPE = "checkboxes";
private final String type = TYPE;
/**
* 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.
*/
private String actionId;
/**
* 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
*
* @see The Pull request #103
* @see A related discussion on StackOverFlow.com
*/
private List options;
/**
* 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.
*/
private List initialOptions;
/**
* A confirm object that defines an optional confirmation dialog
* that appears after clicking one of the checkboxes in this element.
*/
private ConfirmationDialogObject confirm;
}