Class UserUpdateAvatarEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.user.GenericUserEvent

net.dv8tion.jda.api.events.user.update.GenericUserUpdateEvent<String>

net.dv8tion.jda.api.events.user.update.UserUpdateAvatarEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<User,String>

public class UserUpdateAvatarEvent
extends GenericUserUpdateEvent<String>

Indicates that the Avatar of a User changed.

Can be used to retrieve the User who changed their avatar and their previous Avatar ID/URL.

Identifier: avatar

Requirements

This event requires the GUILD_MEMBERS intent to be enabled.
createDefault(String) and createLight(String) disable this by default!

Additionally, this event requires the MemberCachePolicy to cache the updated members. Discord does not specifically tell us about the updates, but merely tells us the member was updated and gives us the updated member object. In order to fire a specific event like this we need to have the old member cached to compare against.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
UserUpdateAvatarEvent(JDA api, long responseNumber, User user, String oldAvatar)

Method Summary

Modifier and Type	Method	Description
ImageProxy	getNewAvatar()	Returns an ImageProxy for this user's new avatar image.
ImageProxy	getNewAvatar(ImageFormat format)	Returns an ImageProxy for this user's new avatar image.
String	getNewAvatarId()	The new avatar id
String	getNewAvatarUrl()	The url of the new avatar
String	getNewAvatarUrl(ImageFormat format)	The url of the new avatar
ImageProxy	getOldAvatar()	Returns an ImageProxy for this user's old avatar image.
ImageProxy	getOldAvatar(ImageFormat format)	Returns an ImageProxy for this user's old avatar image.
String	getOldAvatarId()	The previous avatar id
String	getOldAvatarUrl()	The previous avatar url
String	getOldAvatarUrl(ImageFormat format)	The previous avatar url

Methods inherited from class GenericUserUpdateEvent

getEntity, getNewValue, getOldValue, getPropertyIdentifier

Methods inherited from class GenericUserEvent

getUser

Methods inherited from class Event

getJDA, getRawData, getResponseNumber, toString

Methods inherited from class Object

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

Methods inherited from interface GenericEvent

getJDA, getRawData, getResponseNumber

Methods inherited from interface UpdateEvent

getEntityType

Field Details

IDENTIFIER

public static final String IDENTIFIER

See Also:

• Constant Field Values

Constructor Details

UserUpdateAvatarEvent

public UserUpdateAvatarEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 User user,
 @Nullable
 String oldAvatar)

Method Details

getOldAvatarId

@Nullable
public String getOldAvatarId()

The previous avatar id

Returns:

The previous avatar id

getOldAvatarUrl

@Nullable
public String getOldAvatarUrl()

The previous avatar url

Returns:

The previous avatar url

getOldAvatarUrl

@Nullable
public String getOldAvatarUrl(@Nonnull
 ImageFormat format)

The previous avatar url

Parameters:

format - The format in which the image should be

Returns:

The previous avatar url

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.userAvatar(ImageFormat, String, String)

getOldAvatar

@Nullable
public ImageProxy getOldAvatar()

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

Note: the old avatar may not always be downloadable as it might have been removed from Discord.

Returns:

Possibly-null ImageProxy of this user's old avatar image

See Also:

• getOldAvatarUrl()

getOldAvatar

@Nullable
public ImageProxy getOldAvatar(@Nonnull
 ImageFormat format)

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

Note: the old avatar may not always be downloadable as it might have been removed from Discord.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this user's old avatar image

Throws:

IllegalArgumentException - If the format is null

See Also:

• getOldAvatarUrl(ImageFormat)
• DiscordAssets.userAvatar(ImageFormat, String, String)

getNewAvatarId

@Nullable
public String getNewAvatarId()

The new avatar id

Returns:

The new avatar id

getNewAvatarUrl

@Nullable
public String getNewAvatarUrl()

The url of the new avatar

Returns:

The url of the new avatar

getNewAvatarUrl

@Nullable
public String getNewAvatarUrl(@Nonnull
 ImageFormat format)

The url of the new avatar

Parameters:

format - The format in which the image should be

Returns:

The url of the new avatar

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.userAvatar(ImageFormat, String, String)

getNewAvatar

@Nullable
public ImageProxy getNewAvatar()

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

Returns:

Possibly-null ImageProxy of this user's new avatar image

See Also:

• getNewAvatarUrl()

getNewAvatar

@Nullable
public ImageProxy getNewAvatar(@Nonnull
 ImageFormat format)

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

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this user's new avatar image

Throws:

IllegalArgumentException - If the format is null

See Also:

• getNewAvatarUrl(ImageFormat)
• DiscordAssets.userAvatar(ImageFormat, String, String)