Class User.Profile

java.lang.Object

net.dv8tion.jda.api.entities.User.Profile

Enclosing interface:

User

public static class User.Profile
extends Object

Represents the information contained in a User's profile.

Constructor Summary

Constructors

Constructor	Description
Profile(long userId, String bannerId, int accentColor)

Method Summary

Modifier and Type	Method	Description
Color	getAccentColor()	The user's accent color.
int	getAccentColorRaw()	The raw RGB value of this user's accent color.
ImageProxy	getBanner()	Returns an ImageProxy for this user's banner.
ImageProxy	getBanner(ImageFormat format)	Returns an ImageProxy for this user's banner.
String	getBannerId()	The Discord Id for this user's banner image.
String	getBannerUrl()	The URL for the user's banner image.
String	getBannerUrl(ImageFormat format)	The URL for the user's banner image.
String	toString()

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

Profile

public Profile(long userId,
 String bannerId,
 int accentColor)

Method Details

getBannerId

@Nullable
public String getBannerId()

The Discord Id for this user's banner image. If the user has not set a banner, this will return null.

Returns:

Possibly-null String containing the User banner id.

getBannerUrl

@Nullable
public String getBannerUrl()

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

Returns:

Possibly-null String containing the User banner url.

See Also:

• User.BANNER_URL

getBannerUrl

@Nullable
public String getBannerUrl(@Nonnull
 ImageFormat format)

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

Parameters:

format - The format in which the image should be

Returns:

Possibly-null String containing the User banner url.

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.userBanner(ImageFormat, String, String)

getBanner

@Nullable
public ImageProxy getBanner()

Returns an ImageProxy for this user's banner.

Returns:

Possibly-null ImageProxy of this user's banner

See Also:

• getBannerUrl()

getBanner

@Nullable
public ImageProxy getBanner(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this user's banner.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this user's banner

Throws:

IllegalArgumentException - If the format is null

See Also:

• getBannerUrl(ImageFormat)
• DiscordAssets.userBanner(ImageFormat, String, String)

getAccentColor

@Nullable
public Color getAccentColor()

The user's accent color. If the user has not set an accent color, this will return null. The automatically calculated color is not returned. The accent color is not shown in the client if the user has set a banner.

Returns:

Possibly-null Color containing the User accent color.

getAccentColorRaw

public int getAccentColorRaw()

The raw RGB value of this user's accent color.
Defaults to User.DEFAULT_ACCENT_COLOR_RAW if this user's banner color is not available.

Returns:

The raw RGB color value or User.DEFAULT_ACCENT_COLOR_RAW

toString

public String toString()

Overrides:

toString in class Object