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

Class ChatPostMessageRequest

java.lang.Object
com.slack.api.methods.request.chat.ChatPostMessageRequest
All Implemented Interfaces:
SlackApiRequest
public class ChatPostMessageRequest extends Object implements SlackApiRequest
https://docs.slack.dev/reference/methods/chat.postMessage

  • Method Details

    • isAsUser

      public Boolean isAsUser()

    • setAsUser

      public void setAsUser(Boolean asUser)

    • builder

      public static ChatPostMessageRequest.ChatPostMessageRequestBuilder builder()

    • getToken

      public String getToken()
      Authentication token. Requires scope: `chat:write`
      Specified by:
      getToken in interface SlackApiRequest
      Returns:
      token string value or null

    • getUsername

      public String getUsername()
      Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.

    • getThreadTs

      public String getThreadTs()
      Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.

    • getChannel

      public String getChannel()
      Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.

    • getText

      public 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.

    • getParse

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

    • isLinkNames

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

    • getMetadata

      public Message.Metadata getMetadata()
      JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

    • getMetadataAsString

      public String getMetadataAsString()
      JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

    • getEventAndEntityMetadata

      public Message.EventAndEntityMetadata getEventAndEntityMetadata()
      JSON object with event and/or entity metadata. For event metadata, provide event_type and event_payload fields. For entity metadata, provide the entities field. This field will overwrite the `metadata` field.

    • getEventAndEntityMetadataAsString

      public String getEventAndEntityMetadataAsString()
      JSON object with event and/or entity metadata. For event metadata, provide event_type and event_payload fields. For entity metadata, provide the entities field. This field will overwrite the `metadata` field.

    • getBlocks

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

    • getBlocksAsString

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

    • getAttachments

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

    • getAttachmentsAsString

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

    • isUnfurlLinks

      public boolean isUnfurlLinks()
      Pass true to enable unfurling of primarily text-based content.

    • isUnfurlMedia

      public boolean isUnfurlMedia()
      Pass false to disable unfurling of media content.

    • isMrkdwn

      public boolean isMrkdwn()
      Disable Slack markup parsing by setting to `false`. Enabled by default.

    • getIconUrl

      public 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](#authorship) below.

    • getIconEmoji

      public 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](#authorship) below.

    • isReplyBroadcast

      public boolean isReplyBroadcast()
      Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.

    • setToken

      public void setToken(String token)
      Authentication token. Requires scope: `chat:write`
      Specified by:
      setToken in interface SlackApiRequest

    • setUsername

      public void setUsername(String username)
      Set your bot's user name. Must be used in conjunction with `as_user` set to false, otherwise ignored. See [authorship](#authorship) below.

    • setThreadTs

      public void setThreadTs(String threadTs)
      Provide another message's `ts` value to make this message a reply. Avoid using a reply's `ts` value; use its parent instead.

    • setChannel

      public void setChannel(String channel)
      Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name. See [below](#channels) for more details.

    • setText

      public void setText(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.

    • setParse

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

    • setLinkNames

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

    • setMetadata

      public void setMetadata(Message.Metadata metadata)
      JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

    • setMetadataAsString

      public void setMetadataAsString(String metadataAsString)
      JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you post to Slack is accessible to any app or user who is a member of that workspace.

    • setEventAndEntityMetadata

      public void setEventAndEntityMetadata(Message.EventAndEntityMetadata eventAndEntityMetadata)
      JSON object with event and/or entity metadata. For event metadata, provide event_type and event_payload fields. For entity metadata, provide the entities field. This field will overwrite the `metadata` field.

    • setEventAndEntityMetadataAsString

      public void setEventAndEntityMetadataAsString(String eventAndEntityMetadataAsString)
      JSON object with event and/or entity metadata. For event metadata, provide event_type and event_payload fields. For entity metadata, provide the entities field. This field will overwrite the `metadata` field.

    • setBlocks

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

    • setBlocksAsString

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

    • setAttachments

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

    • setAttachmentsAsString

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

    • setUnfurlLinks

      public void setUnfurlLinks(boolean unfurlLinks)
      Pass true to enable unfurling of primarily text-based content.

    • setUnfurlMedia

      public void setUnfurlMedia(boolean unfurlMedia)
      Pass false to disable unfurling of media content.

    • setMrkdwn

      public void setMrkdwn(boolean mrkdwn)
      Disable Slack markup parsing by setting to `false`. Enabled by default.

    • setIconUrl

      public void setIconUrl(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](#authorship) below.

    • setIconEmoji

      public void setIconEmoji(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](#authorship) below.

    • setReplyBroadcast

      public void setReplyBroadcast(boolean replyBroadcast)
      Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation. Defaults to `false`.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • canEqual

      protected boolean canEqual(Object other)

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object