Class GuildUpdateBannerEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

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

net.dv8tion.jda.api.events.guild.update.GenericGuildUpdateEvent<String>

net.dv8tion.jda.api.events.guild.update.GuildUpdateBannerEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<Guild,String>

public class GuildUpdateBannerEvent
extends GenericGuildUpdateEvent<String>

Indicates that the banner of a Guild changed.

Can be used to detect when the banner changes and retrieve the old one

Identifier: banner

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
GuildUpdateBannerEvent(JDA api, long responseNumber, Guild guild, String previous)

Method Summary

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

Methods inherited from class GenericGuildUpdateEvent

getEntity, getNewValue, getOldValue, getPropertyIdentifier

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

GuildUpdateBannerEvent

public GuildUpdateBannerEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 Guild guild,
 @Nullable
 String previous)

Method Details

getNewBannerId

@Nullable
public String getNewBannerId()

The new banner id

Returns:

The new banner id, or null if the banner was removed

getNewBannerUrl

@Nullable
public String getNewBannerUrl()

The new banner url

Returns:

The new banner url, or null if the banner was removed

getNewBannerUrl

@Nullable
public String getNewBannerUrl(@Nonnull
 ImageFormat format)

The new banner url

Parameters:

format - The format in which the image should be

Returns:

The new banner url, or null if the banner was removed

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.guildBanner(ImageFormat, String, String)

getNewBanner

@Nullable
public ImageProxy getNewBanner()

Returns an ImageProxy for this guild's new banner.

Returns:

Possibly-null ImageProxy of this guild's new banner

See Also:

• getNewBannerUrl()

getNewBanner

@Nullable
public ImageProxy getNewBanner(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this guild's new banner.

Parameters:

format - The format in which the image should be

Returns:

Possibly-null ImageProxy of this guild's new banner

Throws:

IllegalArgumentException - If the format is null

See Also:

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

getOldBannerId

@Nullable
public String getOldBannerId()

The old banner id

Returns:

The old banner id, or null if the banner didn't exist

getOldBannerUrl

@Nullable
public String getOldBannerUrl()

The old banner url

Returns:

The old banner url, or null if the banner didn't exist

getOldBannerUrl

@Nullable
public String getOldBannerUrl(@Nonnull
 ImageFormat format)

The old banner url

Parameters:

format - The format in which the image should be

Returns:

The old banner url, or null if the banner didn't exist

Throws:

IllegalArgumentException - If the format is null

See Also:

• DiscordAssets.guildBanner(ImageFormat, String, String)

getOldBanner

@Nullable
public ImageProxy getOldBanner()

Returns an ImageProxy for this guild'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 guild's old banner

See Also:

• getOldBannerUrl()

getOldBanner

@Nullable
public ImageProxy getOldBanner(@Nonnull
 ImageFormat format)

Returns an ImageProxy for this guild'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 guild's old banner

Throws:

IllegalArgumentException - If the format is null

See Also:

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