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

Class ButtonElement

java.lang.Object
com.slack.api.model.block.element.BlockElement
com.slack.api.model.block.element.ButtonElement
public class ButtonElement extends BlockElement
https://api.slack.com/reference/block-kit/block-elements#button

  • Field Details

  • Constructor Details

  • Method Details

    • builder

      public static ButtonElement.ButtonElementBuilder builder()

    • getType

      public String getType()

    • getText

      public PlainTextObject getText()
      A text object that defines the button's text. Can only be of type: plain_text. Maximum length for the text in this field is 75 characters.

    • getActionId

      public String getActionId()
      An identifier for this action. 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.

    • getUrl

      public String getUrl()
      A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 characters. If you're using url, you'll still receive an interaction payload and will need to send an acknowledgement response.

    • getValue

      public String getValue()
      The value to send along with the interaction payload. Maximum length for this field is 2000 characters.

    • getStyle

      public String getStyle()
      Decorates buttons with alternative visual color schemes. Use this option with restraint.

      `primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should only be used for one button within a set.

      `danger` gives buttons a red outline and text, and should be used when the action is destructive. Use danger even more sparingly than `primary`.

      If you don't include this field, the `default` button style will be used.

    • getConfirm

      public ConfirmationDialogObject getConfirm()
      A confirm object that defines an optional confirmation dialog after the button is clicked.

    • getAccessibilityLabel

      public String getAccessibilityLabel()
      A label for longer descriptive text about a button element. This label will be read out by screen readers instead of the button text object. Maximum length for this field is 75 characters.

    • setText

      public void setText(PlainTextObject text)
      A text object that defines the button's text. Can only be of type: plain_text. Maximum length for the text in this field is 75 characters.

    • setActionId

      public void setActionId(String actionId)
      An identifier for this action. 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.

    • setUrl

      public void setUrl(String url)
      A URL to load in the user's browser when the button is clicked. Maximum length for this field is 3000 characters. If you're using url, you'll still receive an interaction payload and will need to send an acknowledgement response.

    • setValue

      public void setValue(String value)
      The value to send along with the interaction payload. Maximum length for this field is 2000 characters.

    • setStyle

      public void setStyle(String style)
      Decorates buttons with alternative visual color schemes. Use this option with restraint.

      `primary` gives buttons a green outline and text, ideal for affirmation or confirmation actions. `primary` should only be used for one button within a set.

      `danger` gives buttons a red outline and text, and should be used when the action is destructive. Use danger even more sparingly than `primary`.

      If you don't include this field, the `default` button style will be used.

    • setConfirm

      public void setConfirm(ConfirmationDialogObject confirm)
      A confirm object that defines an optional confirmation dialog after the button is clicked.

    • setAccessibilityLabel

      public void setAccessibilityLabel(String accessibilityLabel)
      A label for longer descriptive text about a button element. This label will be read out by screen readers instead of the button text object. Maximum length for this field is 75 characters.

    • 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