kord-rest/dev.kord.rest.builder.message.modify/AbstractMessageModifyBuilder

AbstractMessageModifyBuilder

sealed class AbstractMessageModifyBuilder : MessageModifyBuilder(source)

Inheritors

FollowupMessageModifyBuilder

InteractionResponseModifyBuilder

UserMessageModifyBuilder

WebhookMessageModifyBuilder

Properties

allowedMentions

override var allowedMentions: AllowedMentionsBuilder?

The mentions in the message that are allowed to trigger a ping.

override var attachments: MutableList<AttachmentBuilder>?

The attachment objects with filename and description.

override var components: MutableList<MessageComponentBuilder>?

The components to include with the message.

override var content: String?

The message contents (up to 2000 characters).

override var embeds: MutableList<EmbedBuilder>?

Up to 10 embeds (up to 6000 characters).

override var files: MutableList<NamedFile>

The files to include as attachments.

override var flags: MessageFlags?

Optional custom MessageFlags.

override var suppressEmbeds: Boolean?

Do not include any embeds when serializing this message.

Functions

inline fun MessageBuilder.actionRow(builder: ActionRowBuilder.() -> Unit)

Adds an action row configured by the builder to the components of the message.

inline fun MessageModifyBuilder.~~actionRow~~(builder: ActionRowBuilder.() -> Unit)

open fun addFile(name: String, contentProvider: ChannelProvider): NamedFile

Adds a file with name and contentProvider to files.

inline fun MessageBuilder.addFile(name: String, contentProvider: ChannelProvider, builder: AttachmentBuilder.() -> Unit): NamedFile

Adds a file with name and contentProvider to files.

fun MessageBuilder.addFile(path: Path): NamedFile

inline fun MessageBuilder.addFile(path: Path, builder: AttachmentBuilder.() -> Unit): NamedFile

Adds a file with the given path to files.

fun MessageModifyBuilder.~~addFile~~(path: Path): NamedFile

Adds a file with the given path to the attachments.

allowedMentions

inline fun MessageBuilder.allowedMentions(builder: AllowedMentionsBuilder.() -> Unit = {})

Configures the mentions in the message that are allowed to trigger a ping.

inline fun MessageModifyBuilder.~~allowedMentions~~(block: AllowedMentionsBuilder.() -> Unit = {})

Configures the mentions that should trigger a ping. Not calling this function will result in the default behavior (ping everything), calling this function but not configuring it before the request is build will result in all pings being ignored.

inline fun MessageBuilder.embed(builder: EmbedBuilder.() -> Unit)

Adds an embed configured by builder to the embeds of the message.

inline fun MessageModifyBuilder.~~embed~~(block: EmbedBuilder.() -> Unit)

inline fun MessageModifyBuilder.keepAttachment(id: Snowflake, builder: AttachmentBuilder.() -> Unit = {})

Keeps the attachment with the given id, so it will be present after editing the message.

inline fun MessageBuilder.messageFlags(builder: MessageFlags.Builder.() -> Unit)

Sets the flags for the message.

inline fun MessageModifyBuilder.~~messageFlags~~(builder: MessageFlags.Builder.() -> Unit)

Sets/Unsets the MessageFlags for this message.