Package com.slack.api.model.dialog

Class Dialog

java.lang.Object
com.slack.api.model.dialog.Dialog
public class Dialog
extends java.lang.Object
Represents a Slack Modal Dialog
See Also:
Slack Dialogs

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  Dialog.DialogBuilder  

  • Constructor Summary

    Constructors 
    Constructor Description
    Dialog()  
    Dialog​(java.lang.String title, java.lang.String callbackId, java.util.List<DialogElement> elements, java.lang.String submitLabel, boolean notifyOnCancel, java.lang.String state)  

  • Method Summary

    Modifier and Type Method Description
    static Dialog.DialogBuilder builder()  
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.lang.String getCallbackId()
    An identifier strictly for you to recognize submissions of this particular instance of a dialog.
    java.util.List<DialogElement> getElements()
    Up to 5 form elements are allowed per dialog.
    java.lang.String getState()
    An optional string that will be echoed back to your app when a user interacts with your dialog.
    java.lang.String getSubmitLabel()
    User-facing string for whichever button-like thing submits the form, depending on form factor.
    java.lang.String getTitle()
    User-facing title of this entire dialog.
    int hashCode()  
    boolean isNotifyOnCancel()
    Default is false.
    void setCallbackId​(java.lang.String callbackId)
    An identifier strictly for you to recognize submissions of this particular instance of a dialog.
    void setElements​(java.util.List<DialogElement> elements)
    Up to 5 form elements are allowed per dialog.
    void setNotifyOnCancel​(boolean notifyOnCancel)
    Default is false.
    void setState​(java.lang.String state)
    An optional string that will be echoed back to your app when a user interacts with your dialog.
    void setSubmitLabel​(java.lang.String submitLabel)
    User-facing string for whichever button-like thing submits the form, depending on form factor.
    void setTitle​(java.lang.String title)
    User-facing title of this entire dialog.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Constructor Details

    • Dialog

      public Dialog()

    • Dialog

      public Dialog​(java.lang.String title, java.lang.String callbackId, java.util.List<DialogElement> elements, java.lang.String submitLabel, boolean notifyOnCancel, java.lang.String state)

  • Method Details

    • builder

      public static Dialog.DialogBuilder builder()

    • getTitle

      public java.lang.String getTitle()
      User-facing title of this entire dialog. 24 characters to work with and it's required.

    • getCallbackId

      public java.lang.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 java.util.List<DialogElement> getElements()
      Up to 5 form elements are allowed per dialog. Required.

    • getSubmitLabel

      public java.lang.String getSubmitLabel()
      User-facing string for whichever button-like thing submits the form, depending on form factor. Defaults to Submit, 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 java.lang.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​(java.lang.String title)
      User-facing title of this entire dialog. 24 characters to work with and it's required.

    • setCallbackId

      public void setCallbackId​(java.lang.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​(java.util.List<DialogElement> elements)
      Up to 5 form elements are allowed per dialog. Required.

    • setSubmitLabel

      public void setSubmitLabel​(java.lang.String submitLabel)
      User-facing string for whichever button-like thing submits the form, depending on form factor. Defaults to Submit, 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​(java.lang.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.

    • 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

    • toString

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