Package discord4j.core.spec.legacy

Class LegacyMessageCreateSpec

java.lang.Object

discord4j.core.spec.legacy.LegacyMessageCreateSpec

All Implemented Interfaces:

LegacySpec<MultipartRequest<discord4j.discordjson.json.MessageCreateRequest>>

public class LegacyMessageCreateSpec
extends Object
implements LegacySpec<MultipartRequest<discord4j.discordjson.json.MessageCreateRequest>>

LegacySpec used to create Messages to MessageChannels. Clients using this spec must have connected to gateway at least once.

See Also:

Create Message

Constructor Summary

Constructors

Constructor	Description
LegacyMessageCreateSpec()

Method Summary

Modifier and Type	Method	Description
LegacyMessageCreateSpec	addEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)	Adds an embed to the message.
LegacyMessageCreateSpec	addFile(String fileName, InputStream file)	Adds a file as attachment to the created Message.
LegacyMessageCreateSpec	addFileSpoiler(String fileName, InputStream file)	Adds a spoiler file as attachment to the created Message.
MultipartRequest<discord4j.discordjson.json.MessageCreateRequest>	asRequest()
LegacyMessageCreateSpec	setAllowedMentions(AllowedMentions allowedMentions)	Sets an allowed mentions object to the message spec.
LegacyMessageCreateSpec	setComponents(LayoutComponent... components)	Sets the components of the message.
LegacyMessageCreateSpec	setComponents(List<LayoutComponent> components)	Sets the components of the message.
LegacyMessageCreateSpec	setContent(String content)	Sets the created Message contents, up to 2000 characters.
LegacyMessageCreateSpec	setEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)	Deprecated. Use addEmbed(Consumer).
LegacyMessageCreateSpec	setMessageReference(Snowflake messageId)	Adds a message ID to reply to.
LegacyMessageCreateSpec	setNonce(Snowflake nonce)	Sets a nonce that can be used for optimistic message sending.
LegacyMessageCreateSpec	setTts(boolean tts)	Sets whether the created Message is a TTS message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyMessageCreateSpec

public LegacyMessageCreateSpec()

Method Detail

setContent

public LegacyMessageCreateSpec setContent(String content)

Sets the created Message contents, up to 2000 characters.

Parameters:

content - The message contents.

Returns:

This spec.

setNonce

public LegacyMessageCreateSpec setNonce(Snowflake nonce)

Sets a nonce that can be used for optimistic message sending.

Parameters:

nonce - An identifier.

Returns:

This spec.

setTts

public LegacyMessageCreateSpec setTts(boolean tts)

Sets whether the created Message is a TTS message.

Parameters:

tts - If this message is a TTS message.

Returns:

This spec.

setEmbed

@Deprecated
public LegacyMessageCreateSpec setEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)

Deprecated.

Use addEmbed(Consumer).

Sets rich content to the created Message in the form of an Embed object.

This method overrides any embeds added by addEmbed(Consumer).

Parameters:

spec - An LegacyEmbedCreateSpec consumer used to attach rich content when creating a message.

Returns:

This spec.

addEmbed

public LegacyMessageCreateSpec addEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)

Adds an embed to the message.

A message may have up to 10 embeds.

Parameters:

spec - An LegacyEmbedCreateSpec consumer used to attach rich content when creating a message.

Returns:

This spec.

addFile

public LegacyMessageCreateSpec addFile(String fileName,
                                       InputStream file)

Adds a file as attachment to the created Message.

Parameters:

fileName - The filename used in the file being sent.

file - The file contents.

Returns:

This spec.

addFileSpoiler

public LegacyMessageCreateSpec addFileSpoiler(String fileName,
                                              InputStream file)

Adds a spoiler file as attachment to the created Message.

Parameters:

fileName - The filename used in the file being sent.

file - The file contents.

Returns:

This spec.

setAllowedMentions

public LegacyMessageCreateSpec setAllowedMentions(@Nullable
                                                  AllowedMentions allowedMentions)

Sets an allowed mentions object to the message spec. Can be null to reset a configuration added by default.

Parameters:

allowedMentions - The allowed mentions to add.

Returns:

This spec.

setMessageReference

public LegacyMessageCreateSpec setMessageReference(Snowflake messageId)

Adds a message ID to reply to. This requires the Permission.READ_MESSAGE_HISTORY permission, and the referenced message must exist and cannot be a system message.

Parameters:

messageId - The ID of the message to reply to.

Returns:

This spec.

setComponents

public LegacyMessageCreateSpec setComponents(LayoutComponent... components)

Sets the components of the message.

Parameters:

components - The message components.

Returns:

This spec.

setComponents

public LegacyMessageCreateSpec setComponents(List<LayoutComponent> components)

Sets the components of the message.

Parameters:

components - The message components.

Returns:

This spec.

asRequest

public MultipartRequest<discord4j.discordjson.json.MessageCreateRequest> asRequest()

Specified by:

asRequest in interface LegacySpec<MultipartRequest<discord4j.discordjson.json.MessageCreateRequest>>