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

UserMessageCreateBuilder

class UserMessageCreateBuilder : AbstractMessageCreateBuilder, RequestBuilder<MultipartMessageCreateRequest> (source)

Message builder for creating messages as a bot user.

Constructors

UserMessageCreateBuilder

constructor()

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).

failIfNotExists

var failIfNotExists: Boolean?

Whether to error if the referenced message doesn't exist instead of sending as a normal (non-reply) message, defaults to true.

open override val files: MutableList<NamedFile>

The files to include as attachments.

override var flags: MessageFlags?

Optional custom MessageFlags to add to the message created.

messageReference

var messageReference: Snowflake?

The id of the message being replied to.

var nonce: String?

A value that can be used to verify a message was sent (up to 25 characters).

var stickerIds: MutableList<Snowflake>?

The IDs of up to three stickers to send in the message.

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.

override var tts: Boolean?

Whether this message should be played as a text-to-speech 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 MessageCreateBuilder.~~actionRow~~(builder: ActionRowBuilder.() -> Unit)

Adds an Action Row to the message, configured by the builder. A message can have up to 5 action rows.

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 MessageCreateBuilder.~~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 MessageCreateBuilder.~~allowedMentions~~(block: AllowedMentionsBuilder.() -> Unit = {})

Configures the mentions that should trigger a mention (aka 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 MessageCreateBuilder.~~embed~~(block: EmbedBuilder.() -> Unit)

Adds an embed to the message, configured by the block. A message can have up to 10 embeds.

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

Sets the flags for the message.

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

Sets the MessageFlags for the created message.

fun UserMessageCreateBuilder.stickerId(stickerId: Snowflake)

Add a stickerId to stickerIds.

open override fun toRequest(): MultipartMessageCreateRequest