Package com.slack.api.model.dialog
Class Dialog
- java.lang.Object
-
- com.slack.api.model.dialog.Dialog
-
public class Dialog extends Object
Represents a Slack Modal Dialog- See Also:
- Slack Dialogs
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static classDialog.DialogBuilder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static Dialog.DialogBuilderbuilder()protected booleancanEqual(Object other)booleanequals(Object o)StringgetCallbackId()An identifier strictly for you to recognize submissions of this particular instance of a dialog.List<DialogElement>getElements()Up to 5 form elements are allowed per dialog.StringgetState()An optional string that will be echoed back to your app when a user interacts with your dialog.StringgetSubmitLabel()User-facing string for whichever button-like thing submits the form, depending on form factor.StringgetTitle()User-facing title of this entire dialog.inthashCode()booleanisNotifyOnCancel()Default is false.voidsetCallbackId(String callbackId)An identifier strictly for you to recognize submissions of this particular instance of a dialog.voidsetElements(List<DialogElement> elements)Up to 5 form elements are allowed per dialog.voidsetNotifyOnCancel(boolean notifyOnCancel)Default is false.voidsetState(String state)An optional string that will be echoed back to your app when a user interacts with your dialog.voidsetSubmitLabel(String submitLabel)User-facing string for whichever button-like thing submits the form, depending on form factor.voidsetTitle(String title)User-facing title of this entire dialog.StringtoString()
-
-
-
Method Detail
-
builder
public static Dialog.DialogBuilder builder()
-
getTitle
public String getTitle()
User-facing title of this entire dialog. 24 characters to work with and it's required.
-
getCallbackId
public String getCallbackId()
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.
-
getElements
public List<DialogElement> getElements()
Up to 5 form elements are allowed per dialog. Required.
-
getSubmitLabel
public String getSubmitLabel()
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.
-
isNotifyOnCancel
public boolean isNotifyOnCancel()
Default is false. When set to true, we'll notify your request URL whenever there's a user-induced dialog cancellation.
-
getState
public String getState()
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.
-
setTitle
public void setTitle(String title)
User-facing title of this entire dialog. 24 characters to work with and it's required.
-
setCallbackId
public void setCallbackId(String 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.
-
setElements
public void setElements(List<DialogElement> elements)
Up to 5 form elements are allowed per dialog. Required.
-
setSubmitLabel
public void setSubmitLabel(String 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.
-
setNotifyOnCancel
public void setNotifyOnCancel(boolean notifyOnCancel)
Default is false. When set to true, we'll notify your request URL whenever there's a user-induced dialog cancellation.
-
setState
public void setState(String 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.
-
canEqual
protected boolean canEqual(Object other)
-
-