com.slack.api.model.block.element

Class ButtonElement.ButtonElementBuilder

java.lang.Object

com.slack.api.model.block.element.ButtonElement.ButtonElementBuilder

Enclosing class:

ButtonElement

public static class ButtonElement.ButtonElementBuilder
extends Object

Method Summary

Modifier and Type	Method and Description
ButtonElement.ButtonElementBuilder	actionId(String actionId) An identifier for this action.
ButtonElement	build()
ButtonElement.ButtonElementBuilder	confirm(ConfirmationDialogObject confirm) A confirm object that defines an optional confirmation dialog after the button is clicked.
ButtonElement.ButtonElementBuilder	style(String style) Decorates buttons with alternative visual color schemes.
ButtonElement.ButtonElementBuilder	text(PlainTextObject text) A text object that defines the button's text.
String	toString()
ButtonElement.ButtonElementBuilder	url(String url) A URL to load in the user's browser when the button is clicked.
ButtonElement.ButtonElementBuilder	value(String value) The value to send along with the interaction payload.

Methods inherited from class java.lang.Object

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

Method Detail

text

public ButtonElement.ButtonElementBuilder text(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.

actionId

public ButtonElement.ButtonElementBuilder actionId(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.

url

public ButtonElement.ButtonElementBuilder url(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.

value

public ButtonElement.ButtonElementBuilder value(String value)

The value to send along with the interaction payload. Maximum length for this field is 2000 characters.

style

public ButtonElement.ButtonElementBuilder style(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.

confirm

public ButtonElement.ButtonElementBuilder confirm(ConfirmationDialogObject confirm)

A confirm object that defines an optional confirmation dialog after the button is clicked.

build

public ButtonElement build()

toString

public String toString()

Overrides:

toString in class Object