Class RoleIcon

java.lang.Object

net.dv8tion.jda.api.entities.RoleIcon

public class RoleIcon
extends Object

An object representing a Role's icon.

See Also:

• Role.getIcon()

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ICON_URL	Deprecated. Replaced by DiscordAssets.roleIcon(ImageFormat, String, String)

Constructor Summary

Constructors

Constructor	Description
RoleIcon(String iconId, String emoji, long roleId)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getEmoji()	The Unicode Emoji of this Role that is used instead of a custom image.
ImageProxy	getIcon()	Returns an ImageProxy for this role's icon.
ImageProxy	getIcon(ImageFormat format)	Returns an ImageProxy for this role's icon.
String	getIconId()	The Discord hash-id of the Role icon image.
String	getIconUrl()	The URL of the Role icon image.
String	getIconUrl(ImageFormat format)	The URL of the Role icon image.
int	hashCode()
boolean	isEmoji()	Whether this RoleIcon is an emoji instead of a custom image.

Methods inherited from class Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Details

ICON_URL

@Deprecated
public static final String ICON_URL

Deprecated.

Replaced by DiscordAssets.roleIcon(ImageFormat, String, String)

Template for getIconUrl().

See Also:

• Constant Field Values

Constructor Details

RoleIcon

public RoleIcon(String iconId,
 String emoji,
 long roleId)

Method Details

getIconId

@Nullable
public String getIconId()

The Discord hash-id of the Role icon image. If no icon has been set or an emoji is used in its place, this returns null.

The Role icon can be modified using RoleManager.setIcon(Icon).

Returns:

Possibly-null String containing the Role's icon hash-id.

getIconUrl

@Nullable
public String getIconUrl()

The URL of the Role icon image. If no icon has been set or an emoji is used in its place, this returns null.

The Role icon can be modified using RoleManager.setIcon(Icon).

Returns:

Possibly-null String containing the Role's icon URL.

getIconUrl

@Nullable
public String getIconUrl(@Nonnull
 ImageFormat format)

The URL of the Role icon image. If no icon has been set or an emoji is used in its place, this returns null.

The Role icon can be modified using RoleManager.setIcon(Icon).

Parameters:

format - The format in which the image should be

Returns:

Possibly-null String containing the Role's icon URL.

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.roleIcon(ImageFormat, String, String)

getIcon

@Nullable
public ImageProxy getIcon()

Returns an ImageProxy for this role's icon.

Returns:

Possibly-null ImageProxy of this role's icon

See Also:

• getIconUrl()

getIcon

@Nullable
public ImageProxy getIcon(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this role's icon.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this role's icon

Throws:

IllegalArgumentException - If the format is null

See Also:

• getIconUrl(ImageFormat)
• DiscordAssets.roleIcon(ImageFormat, String, String)

getEmoji

@Nullable
public String getEmoji()

The Unicode Emoji of this Role that is used instead of a custom image. If no emoji has been set, this returns null.

The Role emoji can be modified using RoleManager.setIcon(String).

Returns:

Possibly-null String containing the Role's Unicode Emoji.

isEmoji

public boolean isEmoji()

Whether this RoleIcon is an emoji instead of a custom image.

Returns:

True, if this RoleIcon is an emoji

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object