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

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ButtonElement.ButtonElementBuilder  

  • Field Summary

    Fields 
    Modifier and Type Field Description
    static java.lang.String TYPE  

  • Constructor Summary

    Constructors 
    Constructor Description
    ButtonElement()  
    ButtonElement​(PlainTextObject text, java.lang.String actionId, java.lang.String url, java.lang.String value, java.lang.String style, ConfirmationDialogObject confirm)  

  • Method Summary

    Modifier and Type Method Description
    static ButtonElement.ButtonElementBuilder builder()  
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.String getActionId()
    An identifier for this action.
    ConfirmationDialogObject getConfirm()
    A confirm object that defines an optional confirmation dialog after the button is clicked.
    java.lang.String getStyle()
    Decorates buttons with alternative visual color schemes.
    PlainTextObject getText()
    A text object that defines the button's text.
    java.lang.String getType()  
    java.lang.String getUrl()
    A URL to load in the user's browser when the button is clicked.
    java.lang.String getValue()
    The value to send along with the interaction payload.
    int hashCode()  
    void setActionId​(java.lang.String actionId)
    An identifier for this action.
    void setConfirm​(ConfirmationDialogObject confirm)
    A confirm object that defines an optional confirmation dialog after the button is clicked.
    void setStyle​(java.lang.String style)
    Decorates buttons with alternative visual color schemes.
    void setText​(PlainTextObject text)
    A text object that defines the button's text.
    void setUrl​(java.lang.String url)
    A URL to load in the user's browser when the button is clicked.
    void setValue​(java.lang.String value)
    The value to send along with the interaction payload.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

  • Method Details

    • builder

      public static ButtonElement.ButtonElementBuilder builder()

    • getType

      public java.lang.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 java.lang.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 java.lang.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 java.lang.String getValue()
      The value to send along with the interaction payload. Maximum length for this field is 2000 characters.

    • getStyle

      public java.lang.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.

    • 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​(java.lang.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​(java.lang.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​(java.lang.String value)
      The value to send along with the interaction payload. Maximum length for this field is 2000 characters.

    • setStyle

      public void setStyle​(java.lang.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.

    • toString

      public java.lang.String toString()
      Overrides:
      toString in class java.lang.Object

    • equals

      public boolean equals​(java.lang.Object o)
      Overrides:
      equals in class java.lang.Object

    • canEqual

      protected boolean canEqual​(java.lang.Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class java.lang.Object