kord-core/dev.kord.core.entity/ApplicationEmoji

ApplicationEmoji

class ApplicationEmoji(val data: EmojiData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : CustomEmoji(source)

An instance of an emoji belonging to a specific Application.

Constructors

ApplicationEmoji

constructor(data: EmojiData, kord: Kord, supplier: EntitySupplier = kord.defaultSupplier)

Properties

applicationId

val applicationId: Snowflake

data

open override val data: EmojiData

open override val id: Snowflake

The unique identifier of this entity.

image

open val image: Asset

The image of this emoji as an Asset.

isAnimated

open val isAnimated: Boolean

Whether is emoji is animated.

isAvailable

open val isAvailable: Boolean

Whether this emoji can be used, may be false due to loss of Server Boosts.

isManaged

open val isManaged: Boolean

Whether is emote is managed by Discord instead of the guild members.

kord

open override val kord: Kord

The kord instance that created this object.

mention

open override val mention: String

Either the unicode representation of the emoji if it's a StandardEmoji or the mention string if it's a CustomEmoji.

name

open override val name: String?

The name of this emoji.

requiresColons

open val requiresColons: Boolean

Whether this emoji needs to be wrapped in colons.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

user

open val user: UserBehavior?

The User who created the emote, if present.

userId

open val userId: Snowflake?

The id of the User who created the emote, if present.

Functions

compareTo

open operator override fun compareTo(other: Entity): Int

Compares entities on id.

delete

open suspend override fun delete()

Requests to delete this emoji.

edit

inline suspend fun edit(builder: EmojiModifyBuilder.() -> Unit)

Requests to edit the emoji.

equals

open operator override fun equals(other: Any?): Boolean

getUser

open suspend fun getUser(): User?

Requests to get the creator of the emoji as a User, returns null if the User isn't present or userId is null.

hashCode

open override fun hashCode(): Int

toString

open override fun toString(): String

withStrategy

open override fun withStrategy(strategy: EntitySupplyStrategy<*>): ApplicationEmoji

Returns a new ApplicationEmoji with the given strategy.