commonMain.entity.WelcomeScreen.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

import dev.kord.core.Kord
import dev.kord.core.KordObject
import dev.kord.core.cache.data.WelcomeScreenData
import dev.kord.core.entity.channel.WelcomeScreenChannel

/**
 * Shown to new members in community guild, returned when in the invite object.
 *
 * @property description the server description shown in the welcome screen.
 * @property welcomeScreenChannels  The channels shown in the welcome screen.
 */
public class WelcomeScreen(public val data: WelcomeScreenData, override val kord: Kord) : KordObject {

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

    public val welcomeScreenChannels: List
        get() = data.welcomeChannels.map { WelcomeScreenChannel(it, kord) }

}