commonMain.entity.Sticker.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
There is a newer version: 0.15.0
package dev.kord.core.entity

import dev.kord.common.entity.MessageStickerType
import dev.kord.common.entity.Snowflake
import dev.kord.common.entity.optional.unwrap
import dev.kord.common.entity.optional.value
import dev.kord.core.Kord
import dev.kord.core.behavior.StickerBehavior
import dev.kord.core.cache.data.StickerData
import dev.kord.core.cache.data.StickerItemData
import dev.kord.core.cache.data.StickerPackData
import dev.kord.core.supplier.EntitySupplier
import dev.kord.core.supplier.EntitySupplyStrategy

/**
 * A sticker image that can be used in messages.
 */
public open class Sticker(public val data: StickerData, override val kord: Kord)  : KordEntity {

    /**
     * The id of the sticker.
     */
    override val id: Snowflake
        get() = data.id

    /**
     * The id of the pack that contains this sticker.
     */
    public val packId: Snowflake?
        get() = data.packId.value

    /**
     * The name of the sticker.
     */
    public val name: String
        get() = data.name

    /**
     * The description of the sticker.
     */
    public val description: String?
        get() = data.description

    /**
     * The tags of the sticker.
     */
    public val tags: List
        get() = data.tags.value?.split(",")?.map { it.trim() }.orEmpty()

    /**
     * The type of sticker image.
     */
    public val formatType: MessageStickerType
        get() = data.formatType

    public val asset: Asset get() = Asset.sticker(id, formatType, kord)

    public val available: Boolean
        get() = data.available.discordBoolean

    public val sortValue: Int?
        get() = data.sortValue.value

    public val user: User?
        get() = data.user.unwrap { User(it, kord) }

}

public class GuildSticker(data: StickerData, kord: Kord, override val supplier: EntitySupplier = kord.defaultSupplier) : Sticker(data, kord), StickerBehavior {
    override val guildId: Snowflake
        get() = data.guildId.value!!


    override suspend fun asSticker(): Sticker = this

    override suspend fun asStickerOrNull(): Sticker = this

    override fun withStrategy(strategy: EntitySupplyStrategy<*>): Strategizable {
        return GuildSticker(data, kord, supplier)
    }

}



public class StickerItem(
    public val data: StickerItemData,
    override val kord: Kord,
    override val supplier: EntitySupplier = kord.defaultSupplier
) : KordEntity, Strategizable {

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

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

    public val formatType: MessageStickerType
        get() = data.formatType

    public val asset: Asset get() = Asset.sticker(id, formatType, kord)

    public suspend fun getStickerOrNull(): Sticker? =
        supplier.getStickerOrNull(id)


    public suspend fun getSticker(): Sticker =
        supplier.getSticker(id)


    override fun withStrategy(strategy: EntitySupplyStrategy<*>): Strategizable =
        StickerItem(data, kord, strategy.supply(kord))
}

public class StickerPack(public val data: StickerPackData, override val kord: Kord) : KordEntity {

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

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

    public val skuId: Snowflake get() = data.skuId

    public val coverStickerId: Snowflake? get() = data.coverStickerId.value

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

    public val stickers: List get() = data.stickers.map { Sticker(it, kord) }

    public val bannerId: Snowflake get() = data.bannerAssetId

    public val banner: Asset get() = Asset.stickerPackBanner(bannerId, kord)
}