Package com.slack.api.methods.request.chat

Class ChatPostEphemeralRequest

java.lang.Object
com.slack.api.methods.request.chat.ChatPostEphemeralRequest
All Implemented Interfaces:
SlackApiRequest
public class ChatPostEphemeralRequest
extends java.lang.Object
implements SlackApiRequest

  • Nested Class Summary

    Nested Classes 
    Modifier and Type Class Description
    static class  ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder  

  • Method Summary

    Modifier and Type Method Description
    static ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder builder()  
    protected boolean canEqual​(java.lang.Object other)  
    boolean equals​(java.lang.Object o)  
    java.util.List<Attachment> getAttachments()
    A JSON-based array of structured attachments, presented as a URL-encoded string.
    java.lang.String getAttachmentsAsString()
    A JSON-based array of structured attachments, presented as a URL-encoded string.
    java.util.List<LayoutBlock> getBlocks()
    A JSON-based array of structured blocks, presented as a URL-encoded string.
    java.lang.String getBlocksAsString()
    A JSON-based array of structured blocks as a String, presented as a URL-encoded string.
    java.lang.String getChannel()
    Channel, private group, or IM channel to send message to.
    java.lang.String getIconEmoji()
    Emoji to use as the icon for this message.
    java.lang.String getIconUrl()
    URL to an image to use as the icon for this message.
    java.lang.String getParse()
    Change how messages are treated.
    java.lang.String getText()
    Text of the message to send.
    java.lang.String getThreadTs()
    Provide another message's ts value to post this message in a thread.
    java.lang.String getToken()
    Authentication token.
    java.lang.String getUser()
    `id` of the user who will receive the ephemeral message.
    java.lang.String getUsername()
    Set your bot's user name.
    int hashCode()  
    java.lang.Boolean isAsUser()  
    boolean isLinkNames()
    Find and link channel names and usernames.
    void setAsUser​(java.lang.Boolean asUser)  
    void setAttachments​(java.util.List<Attachment> attachments)
    A JSON-based array of structured attachments, presented as a URL-encoded string.
    void setAttachmentsAsString​(java.lang.String attachmentsAsString)
    A JSON-based array of structured attachments, presented as a URL-encoded string.
    void setBlocks​(java.util.List<LayoutBlock> blocks)
    A JSON-based array of structured blocks, presented as a URL-encoded string.
    void setBlocksAsString​(java.lang.String blocksAsString)
    A JSON-based array of structured blocks as a String, presented as a URL-encoded string.
    void setChannel​(java.lang.String channel)
    Channel, private group, or IM channel to send message to.
    void setIconEmoji​(java.lang.String iconEmoji)
    Emoji to use as the icon for this message.
    void setIconUrl​(java.lang.String iconUrl)
    URL to an image to use as the icon for this message.
    void setLinkNames​(boolean linkNames)
    Find and link channel names and usernames.
    void setParse​(java.lang.String parse)
    Change how messages are treated.
    void setText​(java.lang.String text)
    Text of the message to send.
    void setThreadTs​(java.lang.String threadTs)
    Provide another message's ts value to post this message in a thread.
    void setToken​(java.lang.String token)
    Authentication token.
    void setUser​(java.lang.String user)
    `id` of the user who will receive the ephemeral message.
    void setUsername​(java.lang.String username)
    Set your bot's user name.
    java.lang.String toString()  

    Methods inherited from class java.lang.Object

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

  • Method Details

    • isAsUser

      public java.lang.Boolean isAsUser()

    • setAsUser

      public void setAsUser​(java.lang.Boolean asUser)

    • builder

      public static ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder builder()

    • getToken

      public java.lang.String getToken()
      Authentication token. Requires scope: `chat:write`
      Specified by:
      getToken in interface SlackApiRequest

    • getChannel

      public java.lang.String getChannel()
      Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

    • getText

      public java.lang.String getText()
      Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead.

    • getUser

      public java.lang.String getUser()
      `id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.

    • getBlocks

      public java.util.List<LayoutBlock> getBlocks()
      A JSON-based array of structured blocks, presented as a URL-encoded string.

    • getBlocksAsString

      public java.lang.String getBlocksAsString()
      A JSON-based array of structured blocks as a String, presented as a URL-encoded string.

    • getAttachments

      public java.util.List<Attachment> getAttachments()
      A JSON-based array of structured attachments, presented as a URL-encoded string.

    • getAttachmentsAsString

      public java.lang.String getAttachmentsAsString()
      A JSON-based array of structured attachments, presented as a URL-encoded string.

    • getThreadTs

      public java.lang.String getThreadTs()
      Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

    • getIconEmoji

      public java.lang.String getIconEmoji()
      Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • getIconUrl

      public java.lang.String getIconUrl()
      URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • getUsername

      public java.lang.String getUsername()
      Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • isLinkNames

      public boolean isLinkNames()
      Find and link channel names and usernames.

    • getParse

      public java.lang.String getParse()
      Change how messages are treated. Defaults to `none`. See [below](#formatting).

    • setToken

      public void setToken​(java.lang.String token)
      Authentication token. Requires scope: `chat:write`

    • setChannel

      public void setChannel​(java.lang.String channel)
      Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

    • setText

      public void setText​(java.lang.String text)
      Text of the message to send. See below for an explanation of [formatting](#formatting). This field is usually required, unless you're providing only `attachments` instead.

    • setUser

      public void setUser​(java.lang.String user)
      `id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.

    • setBlocks

      public void setBlocks​(java.util.List<LayoutBlock> blocks)
      A JSON-based array of structured blocks, presented as a URL-encoded string.

    • setBlocksAsString

      public void setBlocksAsString​(java.lang.String blocksAsString)
      A JSON-based array of structured blocks as a String, presented as a URL-encoded string.

    • setAttachments

      public void setAttachments​(java.util.List<Attachment> attachments)
      A JSON-based array of structured attachments, presented as a URL-encoded string.

    • setAttachmentsAsString

      public void setAttachmentsAsString​(java.lang.String attachmentsAsString)
      A JSON-based array of structured attachments, presented as a URL-encoded string.

    • setThreadTs

      public void setThreadTs​(java.lang.String threadTs)
      Provide another message's ts value to post this message in a thread. Avoid using a reply's ts value; use its parent's value instead. Ephemeral messages in threads are only shown if there is already an active thread.

    • setIconEmoji

      public void setIconEmoji​(java.lang.String iconEmoji)
      Emoji to use as the icon for this message. Overrides icon_url. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • setIconUrl

      public void setIconUrl​(java.lang.String iconUrl)
      URL to an image to use as the icon for this message. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • setUsername

      public void setUsername​(java.lang.String username)
      Set your bot's user name. Must be used in conjunction with as_user set to false, otherwise ignored. See authorship below. https://api.slack.com/methods/chat.postEphemeral#authorship

    • setLinkNames

      public void setLinkNames​(boolean linkNames)
      Find and link channel names and usernames.

    • setParse

      public void setParse​(java.lang.String parse)
      Change how messages are treated. Defaults to `none`. See [below](#formatting).

    • 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