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

InteractionResponseCreateBuilder

class InteractionResponseCreateBuilder(val ephemeral: Boolean = false) : MessageCreateBuilder, RequestBuilder<MultipartInteractionResponseCreateRequest> (source)

Message builder for publicly responding to an interaction.

Constructors

InteractionResponseCreateBuilder

constructor(ephemeral: Boolean = false)

Functions

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 the name and contentProvider to the attachments.

fun MessageCreateBuilder.addFile(path: Path): NamedFile

Adds a file with the given path to the attachments.

allowedMentions

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 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 MessageCreateBuilder.messageFlags(builder: MessageFlags.Builder.() -> Unit)

Sets the MessageFlags for the created message.

open override fun toRequest(): MultipartInteractionResponseCreateRequest

Properties

allowedMentions

open override var allowedMentions: AllowedMentionsBuilder?

The mentions in this message that are allowed to raise a notification. Setting this to null will default to creating notifications for all mentions.

open override val components: MutableList<MessageComponentBuilder>

The message components to include in this message.

open override var content: String?

The text content of the message.

open override val embeds: MutableList<EmbedBuilder>

The embedded content of the message.

val ephemeral: Boolean = false

open override val files: MutableList<NamedFile>

The files to include as attachments.

open override var flags: MessageFlags?

Optional custom MessageFlags to add to the message created.

open override var suppressEmbeds: Boolean?

Do not include any embeds when serializing this message.

suppressNotifications

open override var suppressNotifications: Boolean?

This message will not trigger push and desktop notifications.

open override var tts: Boolean?

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