Package net.dv8tion.jda.api.entities

Interface User

All Superinterfaces:

Formattable, IMentionable, ISnowflake, UserSnowflake

All Known Subinterfaces:

SelfUser

public interface User
extends UserSnowflake

Represents a Discord User. Contains all publicly available information about a specific Discord User.

Formattable
This interface extends Formattable and can be used with a Formatter such as used by String.format(String, Object...) or PrintStream.printf(String, Object...).

This will use IMentionable.getAsMention() rather than Object.toString()!
Supported Features:

• Alternative
  - Uses the Discord Tag (Username#Discriminator) instead (Example: %#s - results in getName()#getDiscriminator() -> Minn#6688)
• Width/Left-Justification
  - Ensures the size of a format (Example: %20s - uses at minimum 20 chars; %-10s - uses left-justified padding)
• Precision
  - Cuts the content to the specified size (Example: %.20s)

More information on formatting syntax can be found in the format syntax documentation!

See Also:

• openPrivateChannel()
• JDA.getUserCache()
• JDA.getUserById(long)
• JDA.getUserByTag(String)
• JDA.getUserByTag(String, String)
• JDA.getUsersByName(String, boolean)
• JDA.getUsers()
• JDA.retrieveUserById(String)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	User.Profile	Represents the information contained in a User's profile.
static enum	User.UserFlag	Represents the bit offsets used by Discord for public flags

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AVATAR_URL	Template for getAvatarUrl().
static final String	BANNER_URL	Template for User.Profile.getBannerUrl()
static final int	DEFAULT_ACCENT_COLOR_RAW	Used to keep consistency between color values used in the API
static final String	DEFAULT_AVATAR_URL	Template for getDefaultAvatarUrl()
static final Pattern	USER_TAG	Compiled pattern for a Discord Tag: (.{2,32})#(\d{4})

Method Summary

Modifier and Type	Method	Description
static UserSnowflake	fromId(long id)	Creates a User instance which only wraps an ID.
static UserSnowflake	fromId(String id)	Creates a User instance which only wraps an ID.
String	getAsTag()	The "tag" for this user
default ImageProxy	getAvatar()	Returns an ImageProxy for this user's avatar.
String	getAvatarId()	The Discord ID for this user's avatar image.
default String	getAvatarUrl()	The URL for the user's avatar image.
default ImageProxy	getDefaultAvatar()	Returns an ImageProxy for this user's default avatar.
String	getDefaultAvatarId()	The Discord ID for this user's default avatar image.
default String	getDefaultAvatarUrl()	The URL for the user's default avatar image.
String	getDiscriminator()	The discriminator of the User.
default ImageProxy	getEffectiveAvatar()	Returns an ImageProxy for this user's effective avatar image.
default String	getEffectiveAvatarUrl()	The URL for the user's avatar image.
EnumSet<User.UserFlag>	getFlags()	Returns the UserFlags of this user.
int	getFlagsRaw()	Returns the bitmask representation of the UserFlags of this user.
JDA	getJDA()	Returns the JDA instance of this User
List<Guild>	getMutualGuilds()	Finds and collects all Guild instances that contain this User within the current JDA instance.
String	getName()	The username of the User.
boolean	hasPrivateChannel()	Whether or not the currently logged in user and this user have a currently open PrivateChannel or not.
boolean	isBot()	Returns whether or not the given user is a Bot-Account (special badge in client, some different behaviour)
boolean	isSystem()	Returns whether or not the given user is a System account, which includes the urgent message account and the community updates bot.
CacheRestAction<PrivateChannel>	openPrivateChannel()	Opens a PrivateChannel with this User.
CacheRestAction<User.Profile>	retrieveProfile()	Loads the user's User.Profile data.

Methods inherited from interface net.dv8tion.jda.api.entities.IMentionable

formatTo, getAsMention

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getIdLong, getTimeCreated

Field Details

USER_TAG

static final Pattern USER_TAG

Compiled pattern for a Discord Tag: (.{2,32})#(\d{4})

AVATAR_URL

static final String AVATAR_URL

Template for getAvatarUrl().

See Also:

• Constant Field Values

DEFAULT_AVATAR_URL

static final String DEFAULT_AVATAR_URL

Template for getDefaultAvatarUrl()

See Also:

• Constant Field Values

BANNER_URL

static final String BANNER_URL

Template for User.Profile.getBannerUrl()

See Also:

• Constant Field Values

DEFAULT_ACCENT_COLOR_RAW

static final int DEFAULT_ACCENT_COLOR_RAW

Used to keep consistency between color values used in the API

See Also:

• Constant Field Values

Method Details

fromId

@Nonnull
static UserSnowflake fromId(long id)

Creates a User instance which only wraps an ID.

Parameters:

id - The user id

Returns:

A UserSnowflake instance

See Also:

• JDA.retrieveUserById(long)
• UserSnowflake.fromId(long)

fromId

@Nonnull
static UserSnowflake fromId(@Nonnull
 String id)

Creates a User instance which only wraps an ID.

Parameters:

id - The user id

Returns:

A UserSnowflake instance

Throws:

IllegalArgumentException - If the provided ID is not a valid snowflake

See Also:

• JDA.retrieveUserById(String)
• UserSnowflake.fromId(String)

getName

@Nonnull
String getName()

The username of the User. Length is between 2 and 32 characters (inclusive).

Returns:

Never-null String containing the User's username.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getDiscriminator

@Nonnull
String getDiscriminator()

The discriminator of the User. Used to differentiate between users with the same usernames.
This only contains the 4 digits after the username and the #.

Returns:

Never-null String containing the User discriminator.

Throws:

UnsupportedOperationException - If this User was created with fromId(long) Ex: 6297

getAvatarId

@Nullable
String getAvatarId()

The Discord ID for this user's avatar image. If the user has not set an image, this will return null.

Returns:

Possibly-null String containing the User avatar id.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getAvatarUrl

@Nullable
default String getAvatarUrl()

The URL for the user's avatar image. If the user has not set an image, this will return null.

Returns:

Possibly-null String containing the User avatar url.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getAvatar

@Nullable
default ImageProxy getAvatar()

Returns an ImageProxy for this user's avatar.

Returns:

Possibly-null ImageProxy of this user's avatar

See Also:

• getAvatarUrl()

getDefaultAvatarId

@Nonnull
String getDefaultAvatarId()

The Discord ID for this user's default avatar image.

Returns:

Never-null String containing the User default avatar id.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getDefaultAvatarUrl

@Nonnull
default String getDefaultAvatarUrl()

The URL for the user's default avatar image.

Returns:

Never-null String containing the User default avatar url.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getDefaultAvatar

@Nonnull
default ImageProxy getDefaultAvatar()

Returns an ImageProxy for this user's default avatar.

Returns:

Never-null ImageProxy of this user's default avatar

See Also:

• getDefaultAvatarUrl()

getEffectiveAvatarUrl

@Nonnull
default String getEffectiveAvatarUrl()

The URL for the user's avatar image. If they do not have an avatar set, this will return the URL of their default avatar

Returns:

Never-null String containing the User effective avatar url.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getEffectiveAvatar

@Nonnull
default ImageProxy getEffectiveAvatar()

Returns an ImageProxy for this user's effective avatar image.

Returns:

Never-null ImageProxy of this user's effective avatar image

See Also:

• getEffectiveAvatarUrl()

retrieveProfile

@Nonnull
@CheckReturnValue
CacheRestAction<User.Profile> retrieveProfile()

Loads the user's User.Profile data. Returns a completed RestAction if this User has been retrieved using JDA.retrieveUserById(long). You can use useCache(false) to force the request for a new profile with up-to-date information.

Returns:

CacheRestAction - Type: User.Profile

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getAsTag

@Nonnull
String getAsTag()

The "tag" for this user

This is the equivalent of calling String.format("%#s", user)

Returns:

Never-null String containing the tag for this user, for example DV8FromTheWorld#6297

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

hasPrivateChannel

boolean hasPrivateChannel()

Whether or not the currently logged in user and this user have a currently open PrivateChannel or not.

Returns:

True if the logged in account shares a PrivateChannel with this user.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

openPrivateChannel

@Nonnull
@CheckReturnValue
CacheRestAction<PrivateChannel> openPrivateChannel()

Opens a PrivateChannel with this User.
If a channel has already been opened with this user, it is immediately returned in the RestAction's success consumer without contacting the Discord API. You can use useCache(false) to force the request for a new channel object, which is rarely useful since the channel id never changes.

Examples

 // Send message without response handling
 public void sendMessage(User user, String content) {
     user.openPrivateChannel()
         .flatMap(channel -> channel.sendMessage(content))
         .queue();
 }

 // Send message and delete 30 seconds later
 public RestAction<Void> sendSecretMessage(User user, String content) {
     return user.openPrivateChannel() // RestAction<PrivateChannel>
                .flatMap(channel -> channel.sendMessage(content)) // RestAction<Message>
                .delay(30, TimeUnit.SECONDS) // RestAction<Message> with delayed response
                .flatMap(Message::delete); // RestAction<Void> (executed 30 seconds after sending)
 }
 

Returns:

CacheRestAction - Type: PrivateChannel
Retrieves the PrivateChannel to use to directly message this User.

Throws:

UnsupportedOperationException - If the recipient User is the currently logged in account (represented by SelfUser) or if the user was created with fromId(long)

See Also:

• JDA.openPrivateChannelById(long)

getMutualGuilds

@Nonnull
List<Guild> getMutualGuilds()

Finds and collects all Guild instances that contain this User within the current JDA instance.

This method is a shortcut for JDA.getMutualGuilds(User).

Returns:

Immutable list of all Guilds that this user is a member of.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

isBot

boolean isBot()

Returns whether or not the given user is a Bot-Account (special badge in client, some different behaviour)

Returns:

If the User's Account is marked as Bot

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

isSystem

boolean isSystem()

Returns whether or not the given user is a System account, which includes the urgent message account and the community updates bot.

Returns:

Whether the User's account is marked as System

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getJDA

@Nonnull
JDA getJDA()

Returns the JDA instance of this User

Returns:

the corresponding JDA instance

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getFlags

@Nonnull
EnumSet<User.UserFlag> getFlags()

Returns the UserFlags of this user.

Returns:

EnumSet containing the flags of the user.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)

getFlagsRaw

int getFlagsRaw()

Returns the bitmask representation of the UserFlags of this user.

Returns:

bitmask representation of the user's flags.

Throws:

UnsupportedOperationException - If this User was created with fromId(long)