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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kord-core-jvm Show documentation
Idiomatic Kotlin Wrapper for The Discord API
The newest version!
package dev.kord.core.entity.channel

import dev.kord.common.entity.ChannelFlags
import dev.kord.common.entity.ChannelType
import dev.kord.common.entity.ChannelType.*
import dev.kord.common.entity.Snowflake
import dev.kord.core.Kord
import dev.kord.core.behavior.channel.ChannelBehavior
import dev.kord.core.cache.data.ChannelData
import dev.kord.core.entity.channel.thread.NewsChannelThread
import dev.kord.core.entity.channel.thread.TextChannelThread
import dev.kord.core.entity.channel.thread.ThreadChannel
import dev.kord.core.supplier.EntitySupplier
import dev.kord.core.supplier.EntitySupplyStrategy

/**
 * An instance of a [Discord Channel](https://discord.com/developers/docs/resources/channel)
 */
public interface Channel : ChannelBehavior {
    public val data: ChannelData

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

    /**
     * The type of this channel.
     */
    public val type: ChannelType get() = data.type

    /** The flags of this channel, if present. */
    public val flags: ChannelFlags? get() = data.flags.value

    /**
     * Returns a new [Channel] with the given [strategy].
     */
    override fun withStrategy(strategy: EntitySupplyStrategy<*>): Channel =
        from(data, kord, strategy)

    public companion object {

        /**
         * Creates a [Channel] of the type defined in the [ChannelData.type].
         * If the type is not any known type, then an anonymous channel will be created.
         */
        public fun from(
            data: ChannelData,
            kord: Kord,
            strategy: EntitySupplyStrategy<*> = kord.resources.defaultStrategy
        ): Channel = when (data.type) {
            GuildText -> TextChannel(data, kord)
            DM, GroupDM -> DmChannel(data, kord)
            GuildStageVoice -> StageChannel(data, kord)
            GuildVoice -> VoiceChannel(data, kord)
            GuildCategory -> Category(data, kord)
            GuildNews -> NewsChannel(data, kord)
            GuildForum -> ForumChannel(data, kord)
            GuildMedia -> MediaChannel(data, kord)
            PublicNewsThread -> NewsChannelThread(data, kord)
            PrivateThread, PublicGuildThread -> TextChannelThread(data, kord)

            GuildDirectory, is Unknown -> {
                if (data.threadMetadata.value == null) Channel(data, kord, strategy.supply(kord))
                else ThreadChannel(data, kord, strategy.supply(kord))
            }
        }
    }
}


internal fun Channel(
    data: ChannelData,
    kord: Kord,
    supplier: EntitySupplier = kord.defaultSupplier
): Channel {
    return object : Channel {
        override val data: ChannelData = data
        override val kord: Kord = kord
        override val supplier: EntitySupplier = supplier
    }
}