kord-core/dev.kord.core.entity/GuildEmoji

GuildEmoji

class GuildEmoji(val data: EmojiData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : Emoji, KordEntity, Strategizable(source)

An instance of an emoji belonging to a specific Guild.

Constructors

GuildEmoji

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

Properties

data

val data: EmojiData

guildId

val guildId: Snowflake

open override val id: Snowflake

The unique identifier of this entity.

image

val image: Asset

The image of this emoji as an Asset.

isAnimated

val isAnimated: Boolean

Whether is emoji is animated.

isAvailable

val isAvailable: Boolean

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

isManaged

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.

member

val member: MemberBehavior?

The behavior of the Member who created the emote, if present.

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 GuildEmoji.

name

open override val name: String?

The name of this emoji.

requiresColons

val requiresColons: Boolean

Whether this emoji needs to be wrapped in colons.

roleBehaviors

val roleBehaviors: Set<RoleBehavior>

The behaviors of the roles for which this emoji was whitelisted.

roleIds

val roleIds: Set<Snowflake>

The ids of the roles for which this emoji was whitelisted.

roles

val roles: Flow<Role>

The roles for which this emoji was whitelisted.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

user

val user: UserBehavior?

The User who created the emote, if present.

userId

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

suspend fun delete(reason: String? = null)

Requests to delete this emoji, with the given reason.

edit

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

Requests to edit the emoji.

equals

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

getMember

suspend fun getMember(): Member?

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

getUser

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<*>): GuildEmoji

Returns a new GuildEmoji with the given strategy.