commonMain.entity.Reaction.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.Snowflake
import dev.kord.core.Kord
import dev.kord.core.KordObject
import dev.kord.core.cache.data.ReactionData

/**
 * An instance of a [Discord Reaction](https://discord.com/developers/docs/resources/channel#reaction-object).
 */
public class Reaction(public val data: ReactionData, override val kord: Kord) : KordObject {

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

    /**
     * The amount of users that reacted this emoji to the message.
     */
    public val count: Int get() = data.count

    /**
     * Whether the current user reacted to the message with this emoji.
     */
    public val selfReacted: Boolean get() = data.me

    /**
     * The emoji of this reaction.
     */
    public val emoji: ReactionEmoji
        get() = when (data.emojiId) {
            null -> ReactionEmoji.Unicode(data.emojiName!!)
            else -> ReactionEmoji.Custom(data.emojiId, data.emojiName ?: "", data.emojiAnimated)
        }

    /**
     * Whether the emoji is animated.
     */
    public val isAnimated: Boolean get() = data.emojiAnimated

    override fun toString(): String {
        return "Reaction(data=$data, kord=$kord)"
    }

}