Package com.slack.api.model.dialog
Class Dialog.DialogBuilder
java.lang.Object
com.slack.api.model.dialog.Dialog.DialogBuilder
- Enclosing class:
- Dialog
-
Method Summary
Modifier and TypeMethodDescriptionbuild()
callbackId
(String callbackId) An identifier strictly for you to recognize submissions of this particular instance of a dialog.elements
(List<DialogElement> elements) Up to 5 form elements are allowed per dialog.notifyOnCancel
(boolean notifyOnCancel) Default is false.An optional string that will be echoed back to your app when a user interacts with your dialog.submitLabel
(String submitLabel) User-facing string for whichever button-like thing submits the form, depending on form factor.User-facing title of this entire dialog.toString()
-
Method Details
-
title
User-facing title of this entire dialog. 24 characters to work with and it's required.- Returns:
this
.
-
callbackId
An identifier strictly for you to recognize submissions of this particular instance of a dialog. Use something meaningful to your app. 255 characters maximum. Absolutely required.- Returns:
this
.
-
elements
Up to 5 form elements are allowed per dialog. Required.- Returns:
this
.
-
submitLabel
User-facing string for whichever button-like thing submits the form, depending on form factor. Defaults toSubmit
, localized in whichever language the end user prefers. 24 characters maximum, and may contain only a single word.- Returns:
this
.
-
notifyOnCancel
Default is false. When set to true, we'll notify your request URL whenever there's a user-induced dialog cancellation.- Returns:
this
.
-
state
An optional string that will be echoed back to your app when a user interacts with your dialog. Use it as a pointer to reference sensitive data stored elsewhere.- Returns:
this
.
-
build
-
toString
-