commonMain.entity.channel.WelcomeScreenChannel.kt Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of kord-core Show documentation

Idiomatic Kotlin Wrapper for The Discord API

There is a newer version: 0.15.0

package dev.kord.core.entity.channel

import dev.kord.common.entity.Snowflake
import dev.kord.core.Kord
import dev.kord.core.behavior.channel.ChannelBehavior
import dev.kord.core.cache.data.WelcomeScreenChannelData
import dev.kord.core.supplier.EntitySupplier

/**
 * One of the channels shown in the welcome screen
 *
 * @property id the id of the channel.
 * @property description the description shown for the channel.
 * @property emojiId the emoji id if the emoji is custom.
 * @property emojiName the emoji name if custom, the unicode character if standard, or `null` if no emoji is set.
 */
public class WelcomeScreenChannel(
    public val data: WelcomeScreenChannelData,
    override val kord: Kord,
    override val supplier: EntitySupplier = kord.defaultSupplier,
) : ChannelBehavior {

    override val id: Snowflake
        get() = data.channelId

    public val description: String get() = data.description

    public val emojiId: Snowflake? get() = data.emojiId

    public val emojiName: String? get() = data.emojiName

}