Package discord4j.core.spec.legacy

Class LegacyMessageEditSpec

java.lang.Object

discord4j.core.spec.legacy.LegacyMessageEditSpec

All Implemented Interfaces:

LegacySpec<discord4j.discordjson.json.MessageEditRequest>

public class LegacyMessageEditSpec
extends Object
implements LegacySpec<discord4j.discordjson.json.MessageEditRequest>

LegacySpec used to edit Message entities this client has sent before.

See Also:

Edit Message

Constructor Summary

Constructors

Constructor	Description
LegacyMessageEditSpec()

Method Summary

Modifier and Type	Method	Description
LegacyMessageEditSpec	addEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)	Adds an embed to the edit request.
discord4j.discordjson.json.MessageEditRequest	asRequest()
LegacyMessageEditSpec	removeEmbeds()	Removes all of the embeds on the message.
LegacyMessageEditSpec	setAllowedMentions(AllowedMentions allowedMentions)	Sets the new allowed mentions for the edited Message.
LegacyMessageEditSpec	setComponents(LayoutComponent... components)	Sets the components of the message.
LegacyMessageEditSpec	setComponents(List<LayoutComponent> components)	Sets the components of the message.
LegacyMessageEditSpec	setContent(String content)	Sets the new contents for the edited Message.
LegacyMessageEditSpec	setEmbed(Consumer<? super LegacyEmbedCreateSpec> spec)	Deprecated. Use addEmbed(Consumer) or removeEmbeds()
LegacyMessageEditSpec	setFlags(Message.Flag... flags)	Sets the flags for the edited Message.

Methods inherited from class java.lang.Object

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

Constructor Detail

LegacyMessageEditSpec

public LegacyMessageEditSpec()

Method Detail

setContent

public LegacyMessageEditSpec setContent(@Nullable
                                        String content)

Sets the new contents for the edited Message.

Parameters:

content - This message contents.

Returns:

This spec.

setEmbed

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

Deprecated.

Use addEmbed(Consumer) or removeEmbeds()

Sets the new rich content for the edited Message.

Parameters:

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

Returns:

This spec.

addEmbed

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

Adds an embed to the edit request.

Warning: This method does not add an embed to the embeds already existing on the message. That is, if a message has embeds A and B, editing it with addEmbed(C) will result in the message having only embed C. To actually add embed C to the message, all embeds must be sent (i.e., do addEmbed(A).addEmbed(B).addEmbed(C).

Parameters:

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

Returns:

This spec.

removeEmbeds

public LegacyMessageEditSpec removeEmbeds()

Removes all of the embeds on the message.

Returns:

This spec.

setAllowedMentions

public LegacyMessageEditSpec setAllowedMentions(@Nullable
                                                AllowedMentions allowedMentions)

Sets the new allowed mentions for the edited Message.

Parameters:

allowedMentions - This message allowed mentions.

Returns:

This spec.

setFlags

public LegacyMessageEditSpec setFlags(@Nullable
                                      Message.Flag... flags)

Sets the flags for the edited Message.

Parameters:

flags - An array of Message.Flag to set on the edited message.

Returns:

This spec.

setComponents

public LegacyMessageEditSpec setComponents(LayoutComponent... components)

Sets the components of the message.

Parameters:

components - The message components.

Returns:

This spec.

setComponents

public LegacyMessageEditSpec setComponents(List<LayoutComponent> components)

Sets the components of the message.

Parameters:

components - The message components.

Returns:

This spec.

asRequest

public discord4j.discordjson.json.MessageEditRequest asRequest()

Specified by:

asRequest in interface LegacySpec<discord4j.discordjson.json.MessageEditRequest>