kord-core/dev.kord.core.entity/Webhook

Webhook

data class Webhook(val data: WebhookData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : WebhookBehavior, Strategizable(source)

Constructors

Webhook

constructor(data: WebhookData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

channel

val channel: MessageChannelBehavior

channelId

val channelId: Snowflake

creatorId

val creatorId: Snowflake?

data

val data: WebhookData

guild

val guild: GuildBehavior?

guildId

val guildId: Snowflake?

open override val id: Snowflake

The unique identifier of this entity.

kord

open override val kord: Kord

The kord instance that created this object.

name

val name: String?

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

token

val token: String?

type

val type: WebhookType

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

delete

open suspend fun delete(reason: String? = null)

Requests to delete this webhook, this user must be the creator.

open suspend fun delete(token: String, reason: String? = null)

Requests to delete this webhook.

deleteMessage

open suspend fun deleteMessage(token: String, messageId: Snowflake, threadId: Snowflake? = null)

Requests to delete the Message with the given messageId previously sent from this webhook using the token for authentication.

edit

inline suspend fun WebhookBehavior.edit(builder: WebhookModifyBuilder.() -> Unit): Webhook

Requests to edit the webhook, this user must be the creator.

inline suspend fun WebhookBehavior.edit(token: String, builder: WebhookModifyBuilder.() -> Unit): Webhook

Requests to edit the webhook.

equals

open operator override fun equals(other: Any?): Boolean

execute

inline suspend fun WebhookBehavior.execute(token: String, threadId: Snowflake? = null, builder: WebhookMessageCreateBuilder.() -> Unit): Message

Requests to execute this webhook.

executeIgnored

inline suspend fun WebhookBehavior.executeIgnored(token: String, threadId: Snowflake? = null, builder: WebhookMessageCreateBuilder.() -> Unit)

Requests to execute this webhook.

getChannel

suspend fun getChannel(): MessageChannel

Requests to get the channel this webhook operates in.

getChannelOrNull

suspend fun getChannelOrNull(): MessageChannel?

Requests to get the channel this webhook operates in, returns null if the TopGuildMessageChannel isn't present.

getGuildOrNull

suspend fun getGuildOrNull(): Guild?

Requests to get the guild this webhook belongs to, returns null if the Guild isn't present.

getMessage

open suspend fun getMessage(token: String, messageId: Snowflake, threadId: Snowflake? = null): Message

Requests the Message with the given messageId previously sent from this webhook using the token for authentication.

getMessageOrNull

open suspend fun getMessageOrNull(token: String, messageId: Snowflake, threadId: Snowflake? = null): Message?

Requests the Message with the given messageId previously sent from this webhook using the token for authentication, returns null when the message isn't present.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withStrategy

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): Webhook

Returns a new Webhook with the given strategy.