kord-rest/dev.kord.rest.builder.message.create/WebhookMessageCreateBuilder

WebhookMessageCreateBuilder

class WebhookMessageCreateBuilder : AbstractMessageCreateBuilder, RequestBuilder<MultiPartWebhookExecuteRequest> (source)

Message builder for creating messages as a webhook user.

Constructors

constructor()

Properties

allowedMentions

override var allowedMentions: AllowedMentionsBuilder?

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

appliedTags

var appliedTags: MutableList<Snowflake>?

List of tag ids to apply to the thread (requires the webhook channel to be a GuildForum or GuildMedia channel).

attachments

override var attachments: MutableList<AttachmentBuilder>?

The attachment objects with filename and description.

avatarUrl

var avatarUrl: String?

Overrides the default avatar of the webhook.

components

override var components: MutableList<MessageComponentBuilder>?

The components to include with the message.

content

override var content: String?

The message contents (up to 2000 characters).

embeds

override var embeds: MutableList<EmbedBuilder>?

Up to 10 embeds (up to 6000 characters).

files

override val files: MutableList<NamedFile>

The files to include as attachments.

flags

override var flags: MessageFlags?

Optional custom MessageFlags to add to the message created.

suppressEmbeds

override var suppressEmbeds: Boolean?

Do not include any embeds when serializing this message.

suppressNotifications

override var suppressNotifications: Boolean?

This message will not trigger push and desktop notifications.

threadName

var threadName: String?

Name of the thread to create (requires the webhook channel to be a GuildForum or GuildMedia channel).

tts

override var tts: Boolean?

Whether this message should be played as a text-to-speech message.

username

var username: String?

Overrides the default username of the webhook.

Functions

actionRow

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

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

addFile

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

Adds a file with name and contentProvider to files.

addFile

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.

allowedMentions

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

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

applyTag

fun WebhookMessageCreateBuilder.applyTag(tagId: Snowflake)

Add a tagId to appliedTags.

embed

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

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

messageFlags

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

Sets the flags for the message.

toRequest

open override fun toRequest(): MultiPartWebhookExecuteRequest