Class GuildMemberUpdateBannerEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

net.dv8tion.jda.api.events.guild.GenericGuildEvent

net.dv8tion.jda.api.events.guild.member.GenericGuildMemberEvent

net.dv8tion.jda.api.events.guild.member.update.GenericGuildMemberUpdateEvent<String>

net.dv8tion.jda.api.events.guild.member.update.GuildMemberUpdateBannerEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<Member,String>

public class GuildMemberUpdateBannerEvent
extends GenericGuildMemberUpdateEvent<String>

Indicates that a Member updated their Guild banner.

Can be used to retrieve members who change their per guild banner, the triggering guild, the old banner id and the new banner id.

Identifier: banner

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
GuildMemberUpdateBannerEvent(JDA api, long responseNumber, Member member, String oldBannerId)

Method Summary

Modifier and Type	Method	Description
ImageProxy	getNewBanner()	Returns an ImageProxy for this member's new banner.
ImageProxy	getNewBanner(ImageFormat format)	Returns an ImageProxy for this member's new banner.
String	getNewBannerId()	The new banner id
String	getNewBannerUrl()	The url of the new banner
String	getNewBannerUrl(ImageFormat format)	The url of the new banner
ImageProxy	getOldBanner()	Returns an ImageProxy for this member's old banner.
ImageProxy	getOldBanner(ImageFormat format)	Returns an ImageProxy for this member's old banner.
String	getOldBannerId()	The old banner id
String	getOldBannerUrl()	The previous banner url
String	getOldBannerUrl(ImageFormat format)	The previous banner url

Methods inherited from class GenericGuildMemberUpdateEvent

getEntity, getNewValue, getOldValue, getPropertyIdentifier

Methods inherited from class GenericGuildMemberEvent

getMember, getUser

Methods inherited from class GenericGuildEvent

getGuild

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

GuildMemberUpdateBannerEvent

public GuildMemberUpdateBannerEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 Member member,
 @Nullable
 String oldBannerId)

Method Details

getOldBannerId

@Nullable
public String getOldBannerId()

The old banner id

Returns:

The old banner id

getOldBannerUrl

@Nullable
public String getOldBannerUrl()

The previous banner url

Returns:

The previous banner url

getOldBannerUrl

@Nullable
public String getOldBannerUrl(@Nonnull
 ImageFormat format)

The previous banner url

Parameters:

format - The format in which the image should be

Returns:

The previous banner url

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.memberBanner(ImageFormat, String, String, String)

getOldBanner

@Nullable
public ImageProxy getOldBanner()

Returns an ImageProxy for this member's old banner.

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

Returns:

Possibly-null ImageProxy of this member's old banner

See Also:

• getOldBannerUrl()

getOldBanner

@Nullable
public ImageProxy getOldBanner(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this member's old banner.

Note: the old banner 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 member's old banner

Throws:

IllegalArgumentException - If the format is null

See Also:

• getOldBannerUrl(ImageFormat)
• DiscordAssets.memberBanner(ImageFormat, String, String, String)

getNewBannerId

@Nullable
public String getNewBannerId()

The new banner id

Returns:

The new banner id

getNewBannerUrl

@Nullable
public String getNewBannerUrl()

The url of the new banner

Returns:

The url of the new banner

getNewBannerUrl

@Nullable
public String getNewBannerUrl(@Nonnull
 ImageFormat format)

The url of the new banner

Parameters:

format - The format in which the image should be

Returns:

The url of the new banner

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.memberBanner(ImageFormat, String, String, String)

getNewBanner

@Nullable
public ImageProxy getNewBanner()

Returns an ImageProxy for this member's new banner.

Returns:

Possibly-null ImageProxy of this member's new banner

See Also:

• getNewBannerUrl()

getNewBanner

@Nullable
public ImageProxy getNewBanner(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this member's new banner.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this member's new banner

Throws:

IllegalArgumentException - If the format is null

See Also:

• getNewBannerUrl(ImageFormat)
• DiscordAssets.memberBanner(ImageFormat, String, String, String)