kord-core/dev.kord.core.entity/CustomEmoji

CustomEmoji

sealed interface CustomEmoji : Emoji, KordEntity, Strategizable(source)

Supertype for all non-standard emojis.

Inheritors

GuildEmoji

ApplicationEmoji

Properties

data

abstract 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

abstract 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

abstract 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

abstract suspend fun delete()

Requests to delete this emoji.

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.

withStrategy

abstract override fun withStrategy(strategy: EntitySupplyStrategy<*>): CustomEmoji

Returns a copy of this class with a new supplier provided by the strategy.

CustomEmoji

See also

Inheritors

Properties

Functions