kord-core/dev.kord.core.entity.channel/WelcomeScreenChannel

WelcomeScreenChannel

class WelcomeScreenChannel(val data: WelcomeScreenChannelData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : ChannelBehavior(source)

One of the channels shown in the welcome screen

Constructors

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

Properties

data

val data: WelcomeScreenChannelData

description

val description: String

the description shown for the channel.

emojiId

val emojiId: Snowflake?

the emoji id if the emoji is custom.

emojiName

val emojiName: String?

the emoji name if custom, the unicode character if standard, or null if no emoji is set.

open override val id: Snowflake

the id of the channel.

kord

open override val kord: Kord

The kord instance that created this object.

mention

open val mention: String

This channel formatted as a mention as used by the Discord API.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

Functions

asChannel

open suspend fun asChannel(): Channel

Requests to get this behavior as a Channel .

asChannelOf

inline suspend fun <T : Channel> ChannelBehavior.asChannelOf(): T

Requests to get the Channel represented by this ChannelBehavior.

asChannelOfOrNull

inline suspend fun <T : Channel> ChannelBehavior.asChannelOfOrNull(): T?

Requests to get the Channel represented by this ChannelBehavior, returns null if the Channel isn't present.

asChannelOrNull

open suspend fun asChannelOrNull(): Channel?

Requests to get this behavior as a Channel, returns null if the channel isn't present.

compareTo

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

Compares entities on id.

delete

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

Requests to delete a channel (or close it if this is a dm channel).

fetchChannel

open suspend fun fetchChannel(): Channel

Retrieve the Channel associated with this behaviour from the provided EntitySupplier

fetchChannelOrNull

open suspend fun fetchChannelOrNull(): Channel?

Retrieve the Channel associated with this behaviour from the provided EntitySupplier returns null if the Channel isn't present.

withStrategy

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

Returns a new ChannelBehavior with the given strategy.