diskord-core/com.jessecorbett.diskord.api.common/User

User

@Serializable

data class User(val id: String, val username: String, val discriminator: Long, val avatarHash: String?, val isBot: Boolean? = null, val isSystem: Boolean? = null, val twoFactorAuthEnabled: Boolean? = null, val locale: String? = null, val isVerified: Boolean? = null, val email: String? = null, val flags: UserFlags = UserFlags.NONE, val premiumType: PremiumType? = null, val publicFlags: UserFlags = UserFlags.NONE)(source)

Constructors

constructor(id: String, username: String, discriminator: Long, avatarHash: String?, isBot: Boolean? = null, isSystem: Boolean? = null, twoFactorAuthEnabled: Boolean? = null, locale: String? = null, isVerified: Boolean? = null, email: String? = null, flags: UserFlags = UserFlags.NONE, premiumType: PremiumType? = null, publicFlags: UserFlags = UserFlags.NONE)

Properties

@SerialName(value = "avatar")

val avatarHash: String?

@SerialName(value = "discriminator")

val discriminator: Long

@SerialName(value = "email")

val email: String? = null

@SerialName(value = "flags")

val flags: UserFlags

hasCustomAvatar

val User.hasCustomAvatar: Boolean

Convenience method to check if a user has a custom avatar.

@SerialName(value = "id")

@SerialName(value = "bot")

val isBot: Boolean? = null

@SerialName(value = "system")

val isSystem: Boolean? = null

@SerialName(value = "verified")

val isVerified: Boolean? = null

@SerialName(value = "locale")

val locale: String? = null

val User.mention: String

Convenience method to turn a user into a formatted mention for chat.

@SerialName(value = "premium_type")

val premiumType: PremiumType? = null

@SerialName(value = "public_flags")

val publicFlags: UserFlags

twoFactorAuthEnabled

@SerialName(value = "mfa_enabled")

val twoFactorAuthEnabled: Boolean? = null

@SerialName(value = "username")

val username: String

Functions

fun User.gifAvatar(size: Int? = null): String?

Gets the url of the user's avatar in GIF format.

fun User.jpgAvatar(size: Int? = null): String?

Gets the url of the user's avatar in JPG format.

fun User.pngAvatar(size: Int? = null): String

Gets the url of the user's avatar in PNG format.

pngDefaultAvatar

fun User.pngDefaultAvatar(size: Int? = null): String

Gets the url of the user's default avatar in PNG format.

fun User.webpAvatar(size: Int? = null): String?

Gets the url of the user's avatar in WEBP format.