BotCommands-core/io.github.freya022.botcommands.api.core.entities/InputUser

InputUser

interface InputUser : User(source)

Extension of User containing a nullable Member, obtainable on text command and all interactions.

See also

Properties

Link copied to clipboard
@get:Nonnull
abstract val asMention: String
Link copied to clipboard
@get:Nonnull
abstract val asTag: String
Link copied to clipboard
@get:Nullable
open val avatar: ImageProxy?
Link copied to clipboard
@get:Nullable
abstract val avatarId: String?
Link copied to clipboard
@get:Nullable
open val avatarUrl: String?
Link copied to clipboard
@get:Nonnull
open val defaultAvatar: ImageProxy
Link copied to clipboard
@get:Nonnull
abstract val defaultAvatarId: String
Link copied to clipboard
@get:Nonnull
open val defaultAvatarUrl: String
Link copied to clipboard
@get:Nonnull
abstract val discriminator: String
Link copied to clipboard
open override val effectiveAvatar: ImageProxy
Link copied to clipboard
open override val effectiveAvatarUrl: String
Link copied to clipboard
open override val effectiveName: String
Link copied to clipboard
@get:Nonnull
abstract val flags: EnumSet<User.UserFlag?>
Link copied to clipboard
abstract val flagsRaw: Int
Link copied to clipboard
@get:Nullable
abstract val globalName: String?
Link copied to clipboard
@get:Nonnull
open val id: String
Link copied to clipboard
abstract val idLong: Long
Link copied to clipboard
abstract val isBot: Boolean
Link copied to clipboard
abstract val isSystem: Boolean
Link copied to clipboard
@get:Nonnull
abstract val jda: JDA
Link copied to clipboard
abstract val member: Member?

Returns the member object of this user, based on the event's context, or null if the user is not in the guild.

Link copied to clipboard
@get:Nonnull
abstract val mutualGuilds: @Unmodifiable List<Guild?>
Link copied to clipboard
@get:Nonnull
abstract val name: String
Link copied to clipboard
@get:Nullable
abstract val primaryGuild: User.PrimaryGuild?
Link copied to clipboard
@get:Nonnull
open val timeCreated: OffsetDateTime

Functions

Link copied to clipboard
fun User.asInputUser(): InputUser

Wraps this user as an InputUser.

Link copied to clipboard
open fun formatTo(formatter: Formatter?, flags: Int, width: Int, precision: Int)
Link copied to clipboard
open override fun getEffectiveAvatar(): ImageProxy
Link copied to clipboard
open override fun getEffectiveAvatarUrl(): String
Link copied to clipboard
open override fun getEffectiveName(): String
Link copied to clipboard
abstract fun hasPrivateChannel(): Boolean
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun openPrivateChannel(): CacheRestAction<PrivateChannel?>
Link copied to clipboard
@Nonnull
@CheckReturnValue
abstract fun retrieveProfile(): CacheRestAction<User.Profile?>
Generated by Dokka
© 2025 Copyright