commonMain.entity.Asset.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.common.entity.MessageStickerType
import dev.kord.common.entity.Snowflake
import dev.kord.core.Kord
import dev.kord.core.KordObject
import dev.kord.rest.Image
import dev.kord.rest.Image.Format.*
import dev.kord.rest.route.CdnUrl
import dev.kord.rest.route.DiscordCdn

public class Asset private constructor(
    public val isAnimated: Boolean,
    public val cdnUrl: CdnUrl,
    override val kord: Kord,
    private val recommendedFormat: Image.Format? = null,
) : KordObject {

    public suspend fun getImage(format: Image.Format? = null, size: Image.Size? = null): Image = Image.fromUrl(
        client = kord.resources.httpClient,
        url = cdnUrl.toUrl {
            this.format = format ?: recommendedFormat ?: if (isAnimated) GIF else PNG
            if (size != null) this.size = size
        },
    )

    public companion object {
        // see https://discord.com/developers/docs/reference#image-formatting-cdn-endpoints

        private val String.isAnimated get() = startsWith("a_")

        private fun unknownFormatType(formatType: MessageStickerType): Nothing =
            throw IllegalArgumentException("Unknown formatType: $formatType")


        public fun emoji(emojiId: Snowflake, isAnimated: Boolean, kord: Kord): Asset =
            Asset(isAnimated, DiscordCdn.emoji(emojiId), kord)

        public fun guildIcon(guildId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.guildIcon(guildId, hash), kord)

        public fun guildSplash(guildId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.guildSplash(guildId, hash), kord)

        public fun guildDiscoverySplash(guildId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.guildDiscoverySplash(guildId, hash), kord)

        public fun guildBanner(guildId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.guildBanner(guildId, hash), kord)

        public fun userBanner(userId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.userBanner(userId, hash), kord)

        public fun defaultUserAvatar(discriminator: Int, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.defaultUserAvatar(discriminator), kord, recommendedFormat = PNG)

        public fun defaultUserAvatar(userId: Snowflake, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.defaultUserAvatar(userId), kord, recommendedFormat = PNG)

        public fun userAvatar(userId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.userAvatar(userId, hash), kord)

        public fun memberAvatar(guildId: Snowflake, userId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.memberAvatar(guildId, userId, hash), kord)

        // https://github.com/discord/discord-api-docs/pull/5723#issuecomment-1342674515
        public fun userAvatarDecoration(userId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.userAvatarDecoration(userId, hash), kord, recommendedFormat = PNG)

        public fun applicationIcon(applicationId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.applicationIcon(applicationId, hash), kord)

        public fun applicationCover(applicationId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.applicationCover(applicationId, hash), kord)

        public fun stickerPackBanner(bannerId: Snowflake, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.stickerPackBanner(bannerId), kord)

        public fun teamIcon(teamId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.teamIcon(teamId, hash), kord)

        public fun sticker(stickerId: Snowflake, formatType: MessageStickerType, kord: Kord): Asset = Asset(
            isAnimated = when (formatType) {
                MessageStickerType.PNG -> false
                MessageStickerType.APNG, MessageStickerType.LOTTIE, MessageStickerType.GIF -> true
                is MessageStickerType.Unknown -> unknownFormatType(formatType)
            },
            DiscordCdn.sticker(stickerId),
            kord,
            recommendedFormat = when (formatType) {
                MessageStickerType.PNG, MessageStickerType.APNG -> PNG
                MessageStickerType.LOTTIE -> LOTTIE
                MessageStickerType.GIF -> GIF
                is MessageStickerType.Unknown -> unknownFormatType(formatType)
            },
        )

        public fun roleIcon(roleId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.roleIcon(roleId, hash), kord)

        public fun guildScheduledEventCover(eventId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(isAnimated = false, DiscordCdn.guildScheduledEventCover(eventId, hash), kord)

        public fun memberBanner(guildId: Snowflake, userId: Snowflake, hash: String, kord: Kord): Asset =
            Asset(hash.isAnimated, DiscordCdn.memberBanner(guildId, userId, hash), kord)
    }
}