Attachment.AttachmentBuilder (slack-api-model 1.0.10 API)

java.lang.Object
- com.slack.api.model.Attachment.AttachmentBuilder

Enclosing class:: Attachment

public static class Attachment.AttachmentBuilder
extends Object

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Attachment.AttachmentBuilder`	`actions(List<Action> actions)` Actions are defined as an array, and hashes contained within it will be displayed in as buttons in the message attachment.
`Attachment.AttachmentBuilder`	`appUnfurl(Boolean appUnfurl)`
`Attachment.AttachmentBuilder`	`appUnfurlUrl(String appUnfurlUrl)`
`Attachment.AttachmentBuilder`	`authorIcon(String authorIcon)` A valid URL that displays a small 16x16px image to the left of the author_name text.
`Attachment.AttachmentBuilder`	`authorId(String authorId)`
`Attachment.AttachmentBuilder`	`authorLink(String authorLink)` A valid URL that will hyperlink the author_name text mentioned above.
`Attachment.AttachmentBuilder`	`authorName(String authorName)` Small text used to display the author's name.
`Attachment.AttachmentBuilder`	`authorSubname(String authorSubname)`
`Attachment.AttachmentBuilder`	`blocks(List<LayoutBlock> blocks)`
`Attachment.AttachmentBuilder`	`botId(String botId)`
`Attachment`	`build()`
`Attachment.AttachmentBuilder`	`callbackId(String callbackId)` This is optional value that specifies callback id when there are buttons.
`Attachment.AttachmentBuilder`	`channelId(String channelId)`
`Attachment.AttachmentBuilder`	`channelName(String channelName)`
`Attachment.AttachmentBuilder`	`color(String color)` Like traffic signals, color-coding messages can quickly communicate intent and help separate them from the flow of other messages in the timeline.
`Attachment.AttachmentBuilder`	`fallback(String fallback)` A plain-text summary of the attachment.
`Attachment.AttachmentBuilder`	`fields(List<Field> fields)` Fields are defined as an array, and hashes contained within it will be displayed in a table inside the message attachment.
`Attachment.AttachmentBuilder`	`filename(String filename)`
`Attachment.AttachmentBuilder`	`footer(String footer)` Add some brief text to help contextualize and identify an attachment.
`Attachment.AttachmentBuilder`	`footerIcon(String footerIcon)` To render a small icon beside your footer text, provide a publicly accessible URL string in the footer_icon field.
`Attachment.AttachmentBuilder`	`fromUrl(String fromUrl)`
`Attachment.AttachmentBuilder`	`id(Integer id)`
`Attachment.AttachmentBuilder`	`imageBytes(Integer imageBytes)`
`Attachment.AttachmentBuilder`	`imageHeight(Integer imageHeight)`
`Attachment.AttachmentBuilder`	`imageUrl(String imageUrl)` A valid URL to an image file that will be displayed inside a message attachment.
`Attachment.AttachmentBuilder`	`imageWidth(Integer imageWidth)`
`Attachment.AttachmentBuilder`	`indent(Boolean indent)`
`Attachment.AttachmentBuilder`	`metadata(Attachment.AttachmentMetadata metadata)`
`Attachment.AttachmentBuilder`	`mimetype(String mimetype)`
`Attachment.AttachmentBuilder`	`mrkdwnIn(List<String> mrkdwnIn)` By default, message text in attachments are not formatted.
`Attachment.AttachmentBuilder`	`msgSubtype(String msgSubtype)`
`Attachment.AttachmentBuilder`	`msgUnfurl(Boolean msgUnfurl)` NOTE: The the following Booleans (is_msg_unfurl, is_reply_unfurl, is_thread_root_unfurl, is_app_unfurl) default to null intentionally to support block attachments.
`Attachment.AttachmentBuilder`	`originalUrl(String originalUrl)`
`Attachment.AttachmentBuilder`	`pretext(String pretext)` This is optional text that appears above the message attachment block.
`Attachment.AttachmentBuilder`	`replyUnfurl(Boolean replyUnfurl)`
`Attachment.AttachmentBuilder`	`serviceIcon(String serviceIcon)`
`Attachment.AttachmentBuilder`	`serviceName(String serviceName)`
`Attachment.AttachmentBuilder`	`serviceUrl(String serviceUrl)`
`Attachment.AttachmentBuilder`	`size(Integer size)`
`Attachment.AttachmentBuilder`	`text(String text)` This is the main text in a message attachment, and can contain standard message markup (see details below).
`Attachment.AttachmentBuilder`	`threadRootUnfurl(Boolean threadRootUnfurl)`
`Attachment.AttachmentBuilder`	`thumbHeight(Integer thumbHeight)`
`Attachment.AttachmentBuilder`	`thumbUrl(String thumbUrl)` A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment.
`Attachment.AttachmentBuilder`	`thumbWidth(Integer thumbWidth)`
`Attachment.AttachmentBuilder`	`title(String title)` The title is displayed as larger, bold text near the top of a message attachment.
`Attachment.AttachmentBuilder`	`titleLink(String titleLink)` The title is displayed as larger, bold text near the top of a message attachment.
`String`	`toString()`
`Attachment.AttachmentBuilder`	`ts(String ts)` ts (timestamp) Does your attachment relate to something happening at a specific time?
`Attachment.AttachmentBuilder`	`url(String url)`
`Attachment.AttachmentBuilder`	`videoHtml(String videoHtml)`
`Attachment.AttachmentBuilder`	`videoHtmlHeight(Integer videoHtmlHeight)`
`Attachment.AttachmentBuilder`	`videoHtmlWidth(Integer videoHtmlWidth)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Method Detail
  - msgSubtype
```
public Attachment.AttachmentBuilder msgSubtype(String msgSubtype)
```
  - fallback
```
public Attachment.AttachmentBuilder fallback(String fallback)
```
    A plain-text summary of the attachment. This text will be used in clients that don't show formatted text (eg. IRC, mobile notifications) and should not contain any markup.
  - callbackId
```
public Attachment.AttachmentBuilder callbackId(String callbackId)
```
    This is optional value that specifies callback id when there are buttons.
  - color
```
public Attachment.AttachmentBuilder color(String color)
```
    Like traffic signals, color-coding messages can quickly communicate intent and help separate them from the flow of other messages in the timeline.
    An optional value that can either be one of good, warning, danger, or any hex color code (eg. #439FE0). This value is used to color the border along the left side of the message attachment.
  - pretext
```
public Attachment.AttachmentBuilder pretext(String pretext)
```
    This is optional text that appears above the message attachment block.
  - serviceUrl
```
public Attachment.AttachmentBuilder serviceUrl(String serviceUrl)
```
  - serviceName
```
public Attachment.AttachmentBuilder serviceName(String serviceName)
```
  - serviceIcon
```
public Attachment.AttachmentBuilder serviceIcon(String serviceIcon)
```
  - authorId
```
public Attachment.AttachmentBuilder authorId(String authorId)
```
  - authorName
```
public Attachment.AttachmentBuilder authorName(String authorName)
```
    Small text used to display the author's name.
  - authorLink
```
public Attachment.AttachmentBuilder authorLink(String authorLink)
```
    A valid URL that will hyperlink the author_name text mentioned above. Will only work if author_name is present.
  - authorIcon
```
public Attachment.AttachmentBuilder authorIcon(String authorIcon)
```
    A valid URL that displays a small 16x16px image to the left of the author_name text. Will only work if author_name is present.
  - fromUrl
```
public Attachment.AttachmentBuilder fromUrl(String fromUrl)
```
  - originalUrl
```
public Attachment.AttachmentBuilder originalUrl(String originalUrl)
```
  - authorSubname
```
public Attachment.AttachmentBuilder authorSubname(String authorSubname)
```
  - channelId
```
public Attachment.AttachmentBuilder channelId(String channelId)
```
  - channelName
```
public Attachment.AttachmentBuilder channelName(String channelName)
```
  - id
```
public Attachment.AttachmentBuilder id(Integer id)
```
  - botId
```
public Attachment.AttachmentBuilder botId(String botId)
```
  - indent
```
public Attachment.AttachmentBuilder indent(Boolean indent)
```
  - msgUnfurl
```
public Attachment.AttachmentBuilder msgUnfurl(Boolean msgUnfurl)
```
    NOTE: The the following Booleans (is_msg_unfurl, is_reply_unfurl, is_thread_root_unfurl, is_app_unfurl) default to null intentionally to support block attachments.
  - replyUnfurl
```
public Attachment.AttachmentBuilder replyUnfurl(Boolean replyUnfurl)
```
  - threadRootUnfurl
```
public Attachment.AttachmentBuilder threadRootUnfurl(Boolean threadRootUnfurl)
```
  - appUnfurl
```
public Attachment.AttachmentBuilder appUnfurl(Boolean appUnfurl)
```
  - appUnfurlUrl
```
public Attachment.AttachmentBuilder appUnfurlUrl(String appUnfurlUrl)
```
  - title
```
public Attachment.AttachmentBuilder title(String title)
```
    The title is displayed as larger, bold text near the top of a message attachment. By passing a valid URL in the title_link parameter (optional), the title text will be hyperlinked.
  - titleLink
```
public Attachment.AttachmentBuilder titleLink(String titleLink)
```
    The title is displayed as larger, bold text near the top of a message attachment. By passing a valid URL in the title_link parameter (optional), the title text will be hyperlinked.
  - text
```
public Attachment.AttachmentBuilder text(String text)
```
    This is the main text in a message attachment, and can contain standard message markup (see details below). The content will automatically collapse if it contains 700+ characters or 5+ linebreaks, and will display a "Show more..." link to expand the content.
    https://api.slack.com/docs/message-attachments#message_formatting
  - fields
```
public Attachment.AttachmentBuilder fields(List<Field> fields)
```
    Fields are defined as an array, and hashes contained within it will be displayed in a table inside the message attachment.
  - imageUrl
```
public Attachment.AttachmentBuilder imageUrl(String imageUrl)
```
    A valid URL to an image file that will be displayed inside a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
    Large images will be resized to a maximum width of 400px or a maximum height of 500px, while still maintaining the original aspect ratio.
  - imageWidth
```
public Attachment.AttachmentBuilder imageWidth(Integer imageWidth)
```
  - imageHeight
```
public Attachment.AttachmentBuilder imageHeight(Integer imageHeight)
```
  - imageBytes
```
public Attachment.AttachmentBuilder imageBytes(Integer imageBytes)
```
  - thumbUrl
```
public Attachment.AttachmentBuilder thumbUrl(String thumbUrl)
```
    A valid URL to an image file that will be displayed as a thumbnail on the right side of a message attachment. We currently support the following formats: GIF, JPEG, PNG, and BMP.
    The thumbnail's longest dimension will be scaled down to 75px while maintaining the aspect ratio of the image. The filesize of the image must also be less than 500 KB.
    For best results, please use images that are already 75px by 75px.
  - thumbWidth
```
public Attachment.AttachmentBuilder thumbWidth(Integer thumbWidth)
```
  - thumbHeight
```
public Attachment.AttachmentBuilder thumbHeight(Integer thumbHeight)
```
  - videoHtml
```
public Attachment.AttachmentBuilder videoHtml(String videoHtml)
```
  - videoHtmlWidth
```
public Attachment.AttachmentBuilder videoHtmlWidth(Integer videoHtmlWidth)
```
  - videoHtmlHeight
```
public Attachment.AttachmentBuilder videoHtmlHeight(Integer videoHtmlHeight)
```
  - footer
```
public Attachment.AttachmentBuilder footer(String footer)
```
    Add some brief text to help contextualize and identify an attachment. Limited to 300 characters, and may be truncated further when displayed to users in environments with limited screen real estate.
  - footerIcon
```
public Attachment.AttachmentBuilder footerIcon(String footerIcon)
```
    To render a small icon beside your footer text, provide a publicly accessible URL string in the footer_icon field. You must also provide a footer for the field to be recognized.
    We'll render what you provide at 16px by 16px. It's best to use an image that is similarly sized.
  - ts
```
public Attachment.AttachmentBuilder ts(String ts)
```
    ts (timestamp) Does your attachment relate to something happening at a specific time?
    By providing the ts field with an integer value in "epoch time", the attachment will display an additional timestamp value as part of the attachment's footer.
    Use ts when referencing articles or happenings. Your message will have its own timestamp when published.
  - mrkdwnIn
```
public Attachment.AttachmentBuilder mrkdwnIn(List<String> mrkdwnIn)
```
    By default, message text in attachments are not formatted. To enable formatting on attachment fields, add the name of the field (as defined in the API) in this list.
  - actions
```
public Attachment.AttachmentBuilder actions(List<Action> actions)
```
    Actions are defined as an array, and hashes contained within it will be displayed in as buttons in the message attachment.
  - blocks
```
public Attachment.AttachmentBuilder blocks(List<LayoutBlock> blocks)
```
  - filename
```
public Attachment.AttachmentBuilder filename(String filename)
```
  - size
```
public Attachment.AttachmentBuilder size(Integer size)
```
  - mimetype
```
public Attachment.AttachmentBuilder mimetype(String mimetype)
```
  - url
```
public Attachment.AttachmentBuilder url(String url)
```
  - metadata
```
public Attachment.AttachmentBuilder metadata(Attachment.AttachmentMetadata metadata)
```
  - build
```
public Attachment build()
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class Attachment.AttachmentBuilder

Method Summary

Methods inherited from class java.lang.Object

Method Detail

msgSubtype

fallback

callbackId

color

pretext

serviceUrl

serviceName

serviceIcon

authorId

authorName

authorLink

authorIcon

fromUrl

originalUrl

authorSubname

channelId

channelName

id

botId

indent

msgUnfurl

replyUnfurl

threadRootUnfurl

appUnfurl

appUnfurlUrl

title

titleLink

text

fields

imageUrl

imageWidth

imageHeight

imageBytes

thumbUrl

thumbWidth

thumbHeight

videoHtml

videoHtmlWidth

videoHtmlHeight

footer

footerIcon

ts

mrkdwnIn

actions

blocks

filename

size

mimetype

url

metadata

build

toString