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

Link copied to clipboard
constructor()

Properties

Link copied to clipboard
override var allowedMentions: AllowedMentionsBuilder?

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

Link copied to clipboard
override var attachments: MutableList<AttachmentBuilder>?

The attachment objects with filename and description.

Link copied to clipboard
override var components: MutableList<MessageComponentBuilder>?

The components to include with the message.

Link copied to clipboard
override var content: String?

The message contents (up to 2000 characters).

Link copied to clipboard
override var embeds: MutableList<EmbedBuilder>?

Up to 10 embeds (up to 6000 characters).

Link copied to clipboard
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.

Link copied to clipboard
open override val files: MutableList<NamedFile>

The files to include as attachments.

Link copied to clipboard
override var flags: MessageFlags?

Optional custom MessageFlags to add to the message created.

Link copied to clipboard
var messageReference: Snowflake?

The id of the message being replied to.

Link copied to clipboard
var nonce: String?

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

Link copied to clipboard
var stickerIds: MutableList<Snowflake>?

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

Link copied to clipboard
override var suppressEmbeds: Boolean?

Do not include any embeds when serializing this message.

Link copied to clipboard
override var suppressNotifications: Boolean?

This message will not trigger push and desktop notifications.

Link copied to clipboard
override var tts: Boolean?

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

Functions

Link copied to clipboard
inline fun MessageBuilder.actionRow(builder: ActionRowBuilder.() -> Unit)

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

Link copied to clipboard
open fun addFile(name: String, contentProvider: ChannelProvider): NamedFile

Adds a file with name and contentProvider to files.

Link copied to clipboard
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.

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

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

Link copied to clipboard
inline fun MessageBuilder.embed(builder: EmbedBuilder.() -> Unit)

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

Link copied to clipboard
inline fun MessageBuilder.messageFlags(builder: MessageFlags.Builder.() -> Unit)

Sets the flags for the message.

Link copied to clipboard
fun UserMessageCreateBuilder.stickerId(stickerId: Snowflake)

Add a stickerId to stickerIds.

Link copied to clipboard