User

open class User(val data: UserData, val kord: Kord, val supplier: EntitySupplier = kord.defaultSupplier) : UserBehavior(source)

An instance of a Discord User.

Inheritors

Member

Constructors

User

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

Properties

accentColor

val accentColor: Color?

avatar

val avatar: Asset?

The avatar of this user as an Asset.

avatarDecoration

val avatarDecoration: Asset?

avatarDecorationHash

val avatarDecorationHash: String?

avatarHash

val avatarHash: String?

banner

val banner: Asset?

bannerHash

val bannerHash: String?

data

val data: UserData

defaultAvatar

val defaultAvatar: Asset

discriminator

val discriminator: String

The 4-digit code at the end of the user's discord tag.

effectiveName

val User.effectiveName: String

The user's effective name, prioritizing globalName over username.

globalName

val globalName: String?

The user's display name, if it is set. For bots, this is the application name.

open override val id: Snowflake

The unique identifier of this entity.

isBot

val isBot: Boolean

Whether this user is a bot account.

isSelf

val isSelf: Boolean

Returns true if the user is the same as the bot.

kord

open override val kord: Kord

The kord instance that created this object.

mention

open val mention: String

publicFlags

val publicFlags: UserFlags?

The flags on a user's account, if present.

supplier

open override val supplier: EntitySupplier

The supplier used to request entities.

tag

val tag: String

The complete user tag.

username

val username: String

The username of this user.

Functions

asMember

open suspend fun asMember(guildId: Snowflake): Member

Requests to get the this behavior as a Member in the Guild with the guildId.

asMemberOrNull

open suspend fun asMemberOrNull(guildId: Snowflake): Member?

Requests to get this behavior as a Member in the Guild with the guildId, returns null if the member isn't present.

asUser

open suspend override fun asUser(): User

Requests to get the this behavior as a User.

asUserOrNull

open suspend override fun asUserOrNull(): User

Requests to get this behavior as a User, returns null if the user isn't present.

compareTo

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

Compares entities on id.

equals

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

fetchMember

open suspend fun fetchMember(guildId: Snowflake): Member

Retrieve the Member associated with this behaviour from the provided EntitySupplier

fetchMemberOrNull

open suspend fun fetchMemberOrNull(guildId: Snowflake): Member?

Retrieve the Member associated with this behaviour from the provided EntitySupplier returns null if the Member isn't present.

fetchUser

open suspend fun fetchUser(): User

Retrieve the User associated with this behaviour from the provided EntitySupplier

fetchUserOrNull

open suspend fun fetchUserOrNull(): User?

Retrieve the User associated with this behaviour from the provided EntitySupplier returns null if the User isn't present.

getDmChannel

open suspend fun getDmChannel(): DmChannel

Requests to get or create a DmChannel between this bot and the user.

getDmChannelOrNull

open suspend fun getDmChannelOrNull(): DmChannel?

Requests to get or create a DmChannel between this bot and the user, returns null if the user does not allow DMs.

hashCode

open override fun hashCode(): Int

live

@KordPreview

fun User.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job)): LiveUser

@KordPreview

inline fun User.live(coroutineScope: CoroutineScope = kord + SupervisorJob(kord.coroutineContext.job), block: LiveUser.() -> Unit): LiveUser

toString

open override fun toString(): String

withStrategy

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

Returns a new User with the given strategy.