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

Class ChatPostMessageRequest.ChatPostMessageRequestBuilder

java.lang.Object

com.slack.api.methods.request.chat.ChatPostMessageRequest.ChatPostMessageRequestBuilder

Enclosing class:

ChatPostMessageRequest

public static class ChatPostMessageRequest.ChatPostMessageRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ChatPostMessageRequest.ChatPostMessageRequestBuilder	asUser(Boolean asUser)	Deprecated.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	attachments(List<Attachment> attachments)	A JSON-based array of structured attachments, presented as a URL-encoded string.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	attachmentsAsString(String attachmentsAsString)	A JSON-based array of structured attachments, presented as a URL-encoded string.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	blocks(List<LayoutBlock> blocks)	A JSON-based array of structured blocks, presented as a URL-encoded string.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	blocksAsString(String blocksAsString)	A JSON-based array of structured blocks as a String, presented as a URL-encoded string.
ChatPostMessageRequest	build()
ChatPostMessageRequest.ChatPostMessageRequestBuilder	channel(String channel)	Channel, private group, or IM channel to send message to.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	eventAndEntityMetadata(Message.EventAndEntityMetadata eventAndEntityMetadata)	JSON object with event and/or entity metadata.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	eventAndEntityMetadataAsString(String eventAndEntityMetadataAsString)	JSON object with event and/or entity metadata.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	iconEmoji(String iconEmoji)	Emoji to use as the icon for this message.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	iconUrl(String iconUrl)	URL to an image to use as the icon for this message.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	linkNames(boolean linkNames)	Find and link channel names and usernames.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	metadata(Message.Metadata metadata)	JSON object with event_type and event_payload fields, presented as a URL-encoded string.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	metadataAsString(String metadataAsString)	JSON object with event_type and event_payload fields, presented as a URL-encoded string.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	mrkdwn(boolean mrkdwn)	Disable Slack markup parsing by setting to `false`.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	parse(String parse)	Change how messages are treated.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	replyBroadcast(boolean replyBroadcast)	Used in conjunction with `thread_ts` and indicates whether reply should be made visible to everyone in the channel or conversation.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	text(String text)	Text of the message to send.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	threadTs(String threadTs)	Provide another message's `ts` value to make this message a reply.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	token(String token)	Authentication token.
String	toString()
ChatPostMessageRequest.ChatPostMessageRequestBuilder	unfurlLinks(boolean unfurlLinks)	Pass true to enable unfurling of primarily text-based content.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	unfurlMedia(boolean unfurlMedia)	Pass false to disable unfurling of media content.
ChatPostMessageRequest.ChatPostMessageRequestBuilder	username(String username)	Set your bot's user name.

Methods inherited from class java.lang.Object

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

Method Details

token

public ChatPostMessageRequest.ChatPostMessageRequestBuilder token(String token)

Authentication token. Requires scope: `chat:write`

Returns:

this.

username

public ChatPostMessageRequest.ChatPostMessageRequestBuilder username(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.

Returns:

this.

threadTs

public ChatPostMessageRequest.ChatPostMessageRequestBuilder threadTs(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.

Returns:

this.

channel

public ChatPostMessageRequest.ChatPostMessageRequestBuilder channel(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.

Returns:

this.

text

public ChatPostMessageRequest.ChatPostMessageRequestBuilder text(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.

Returns:

this.

parse

public ChatPostMessageRequest.ChatPostMessageRequestBuilder parse(String parse)

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

Returns:

this.

linkNames

public ChatPostMessageRequest.ChatPostMessageRequestBuilder linkNames(boolean linkNames)

Find and link channel names and usernames.

Returns:

this.

metadata

public ChatPostMessageRequest.ChatPostMessageRequestBuilder metadata(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.

Returns:

this.

metadataAsString

public ChatPostMessageRequest.ChatPostMessageRequestBuilder metadataAsString(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.

Returns:

this.

eventAndEntityMetadata

public ChatPostMessageRequest.ChatPostMessageRequestBuilder eventAndEntityMetadata(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.

Returns:

this.

eventAndEntityMetadataAsString

public ChatPostMessageRequest.ChatPostMessageRequestBuilder eventAndEntityMetadataAsString(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.

Returns:

this.

blocks

public ChatPostMessageRequest.ChatPostMessageRequestBuilder blocks(List<LayoutBlock> blocks)

A JSON-based array of structured blocks, presented as a URL-encoded string.

Returns:

this.

blocksAsString

public ChatPostMessageRequest.ChatPostMessageRequestBuilder blocksAsString(String blocksAsString)

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

Returns:

this.

attachments

public ChatPostMessageRequest.ChatPostMessageRequestBuilder attachments(List<Attachment> attachments)

A JSON-based array of structured attachments, presented as a URL-encoded string.

Returns:

this.

attachmentsAsString

public ChatPostMessageRequest.ChatPostMessageRequestBuilder attachmentsAsString(String attachmentsAsString)

A JSON-based array of structured attachments, presented as a URL-encoded string.

Returns:

this.

unfurlLinks

public ChatPostMessageRequest.ChatPostMessageRequestBuilder unfurlLinks(boolean unfurlLinks)

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

Returns:

this.

unfurlMedia

public ChatPostMessageRequest.ChatPostMessageRequestBuilder unfurlMedia(boolean unfurlMedia)

Pass false to disable unfurling of media content.

Returns:

this.

asUser

@Deprecated
public ChatPostMessageRequest.ChatPostMessageRequestBuilder asUser(Boolean asUser)

Deprecated.

Pass true to post the message as the authed user, instead of as a bot. Defaults to false. See [authorship](#authorship) below.

NOTE: The default value is intentionally null to support workplace apps.

Returns:

this.

mrkdwn

public ChatPostMessageRequest.ChatPostMessageRequestBuilder mrkdwn(boolean mrkdwn)

Disable Slack markup parsing by setting to `false`. Enabled by default.

Returns:

this.

iconUrl

public ChatPostMessageRequest.ChatPostMessageRequestBuilder iconUrl(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.

Returns:

this.

iconEmoji

public ChatPostMessageRequest.ChatPostMessageRequestBuilder iconEmoji(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.

Returns:

this.

replyBroadcast

public ChatPostMessageRequest.ChatPostMessageRequestBuilder replyBroadcast(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`.

Returns:

this.

build

public ChatPostMessageRequest build()

toString

public String toString()

Overrides:

toString in class Object