Package com.slack.api.webhook

Class Payload.PayloadBuilder

java.lang.Object

com.slack.api.webhook.Payload.PayloadBuilder

Enclosing class:

Payload

public static class Payload.PayloadBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
Payload.PayloadBuilder	attachments(List<Attachment> attachments)	An array of legacy secondary attachments.
Payload.PayloadBuilder	blocks(List<LayoutBlock> blocks)	An array of layout blocks in the same format as described in the layout block guide.
Payload	build()
Payload.PayloadBuilder	channel(String channel)	Deprecated.
Payload.PayloadBuilder	iconEmoji(String iconEmoji)	Deprecated.
Payload.PayloadBuilder	iconUrl(String iconUrl)	Deprecated.
Payload.PayloadBuilder	metadata(Message.Metadata metadata)	https://api.slack.com/metadata
Payload.PayloadBuilder	text(String text)	The first step is to prepare this message as a key/value pair in JSON.
Payload.PayloadBuilder	threadTs(String threadTs)	You can add the thread_ts parameter to your POST request in order to make your message appear as a reply in a thread.
String	toString()
Payload.PayloadBuilder	unfurlLinks(Boolean unfurlLinks)	Pass true to enable unfurling of primarily text-based content.
Payload.PayloadBuilder	unfurlMedia(Boolean unfurlMedia)	Pass false to disable unfurling of media content.
Payload.PayloadBuilder	username(String username)	Deprecated.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Method Detail

threadTs

public Payload.PayloadBuilder threadTs(String threadTs)

You can add the thread_ts parameter to your POST request in order to make your message appear as a reply in a thread.

Returns:

this.

text

public Payload.PayloadBuilder text(String text)

The first step is to prepare this message as a key/value pair in JSON. For a simple message, your JSON payload only needs to define a text property, containing the text that will be posted to the channel.

Returns:

this.

channel

@Deprecated
public Payload.PayloadBuilder channel(String channel)

Deprecated.

NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

Incoming webhooks output to a default channel and can only send messages to a single channel at a time. You can override a custom integration's configured channel by specifying the channel field in your JSON payload.

Specify a Slack channel by name with "channel": "#other-channel", or send a Slackbot message to a specific user with "channel": "@username".

Returns:

this.

username

@Deprecated
public Payload.PayloadBuilder username(String username)

Deprecated.

NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

Incoming webhooks originate from a default identity you configured when originally creating your webhook. You can override a custom integration's configured name with the username field in your JSON payload.

Returns:

this.

iconUrl

@Deprecated
public Payload.PayloadBuilder iconUrl(String iconUrl)

Deprecated.

NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

You can also override the bot icon either with icon_url or icon_emoji.

Returns:

this.

iconEmoji

@Deprecated
public Payload.PayloadBuilder iconEmoji(String iconEmoji)

Deprecated.

NOTE: No longer works if your webhook is managed in a Slack app while it's still available for the custom integration (https://slack.com/apps/A0F7XDUAZ) in App Directory.

You can also override the bot icon either with icon_url or icon_emoji.

Returns:

this.

blocks

public Payload.PayloadBuilder blocks(List<LayoutBlock> blocks)

An array of layout blocks in the same format as described in the layout block guide.

Returns:

this.

attachments

public Payload.PayloadBuilder attachments(List<Attachment> attachments)

An array of legacy secondary attachments. We recommend you use blocks instead.

Returns:

this.

unfurlLinks

public Payload.PayloadBuilder unfurlLinks(Boolean unfurlLinks)

Pass true to enable unfurling of primarily text-based content.

Returns:

this.

unfurlMedia

public Payload.PayloadBuilder unfurlMedia(Boolean unfurlMedia)

Pass false to disable unfurling of media content.

Returns:

this.

metadata

public Payload.PayloadBuilder metadata(Message.Metadata metadata)

https://api.slack.com/metadata

Returns:

this.

build

public Payload build()

toString

public String toString()

Overrides:

toString in class Object