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

Class ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder

java.lang.Object

com.slack.api.methods.request.chat.ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder

Enclosing class:

ChatPostEphemeralRequest

public static class ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder
extends Object

Method Summary

Modifier and Type	Method	Description
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	asUser(Boolean asUser)	Pass true to post the message as the authed user, instead of as a bot.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	attachments(List<Attachment> attachments)	A JSON-based array of structured attachments, presented as a URL-encoded string.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	attachmentsAsString(String attachmentsAsString)	A JSON-based array of structured attachments, presented as a URL-encoded string.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	blocks(List<LayoutBlock> blocks)	A JSON-based array of structured blocks, presented as a URL-encoded string.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	blocksAsString(String blocksAsString)	A JSON-based array of structured blocks as a String, presented as a URL-encoded string.
ChatPostEphemeralRequest	build()
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	channel(String channel)	Channel, private group, or IM channel to send message to.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	iconEmoji(String iconEmoji)	Emoji to use as the icon for this message.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	iconUrl(String iconUrl)	URL to an image to use as the icon for this message.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	linkNames(boolean linkNames)	Find and link channel names and usernames.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	parse(String parse)	Change how messages are treated.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	text(String text)	Text of the message to send.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	threadTs(String threadTs)	Provide another message's ts value to post this message in a thread.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	token(String token)	Authentication token.
String	toString()
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	user(String user)	`id` of the user who will receive the ephemeral message.
ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder	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 ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder token(String token)

Authentication token. Requires scope: `chat:write`

Returns:

this.

channel

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder channel(String channel)

Channel, private group, or IM channel to send message to. Can be an encoded ID, or a name.

Returns:

this.

text

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

user

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder user(String user)

`id` of the user who will receive the ephemeral message. The user should be in the channel specified by the `channel` argument.

Returns:

this.

asUser

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder asUser(Boolean asUser)

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.

blocks

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder blocks(List<LayoutBlock> blocks)

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

Returns:

this.

blocksAsString

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder blocksAsString(String blocksAsString)

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

Returns:

this.

attachments

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder attachments(List<Attachment> attachments)

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

Returns:

this.

attachmentsAsString

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder attachmentsAsString(String attachmentsAsString)

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

Returns:

this.

threadTs

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder threadTs(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.

Returns:

this.

iconEmoji

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder 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 below. https://api.slack.com/methods/chat.postEphemeral#authorship

Returns:

this.

iconUrl

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder 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 below. https://api.slack.com/methods/chat.postEphemeral#authorship

Returns:

this.

username

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder username(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

Returns:

this.

linkNames

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder linkNames(boolean linkNames)

Find and link channel names and usernames.

Returns:

this.

parse

public ChatPostEphemeralRequest.ChatPostEphemeralRequestBuilder parse(String parse)

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

Returns:

this.

build

public ChatPostEphemeralRequest build()

toString

public String toString()

Overrides:

toString in class Object