Class ScheduledEventUpdateDescriptionEvent

java.lang.Object

net.dv8tion.jda.api.events.Event

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

net.dv8tion.jda.api.events.guild.scheduledevent.GenericScheduledEventGatewayEvent

net.dv8tion.jda.api.events.guild.scheduledevent.update.GenericScheduledEventUpdateEvent<String>

net.dv8tion.jda.api.events.guild.scheduledevent.update.ScheduledEventUpdateDescriptionEvent

All Implemented Interfaces:

GenericEvent, UpdateEvent<ScheduledEvent, String>

public class ScheduledEventUpdateDescriptionEvent
extends GenericScheduledEventUpdateEvent<String>

Indicates the description of a ScheduledEvent has changed.

Can be used to detect when the ScheduledEvent description has changed.

Identifier: description

Requirements

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

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

Field Summary

Fields

Modifier and Type	Field	Description
static final String	IDENTIFIER

Constructor Summary

Constructors

Constructor	Description
ScheduledEventUpdateDescriptionEvent(JDA api, long responseNumber, ScheduledEvent scheduledEvent, String previous)

Method Summary

Modifier and Type	Method	Description
String	getNewDescription()	The new description.
String	getOldDescription()	The old description.

Methods inherited from class GenericScheduledEventUpdateEvent

getEntity, getNewValue, getOldValue, getPropertyIdentifier, toString

Methods inherited from class GenericScheduledEventGatewayEvent

getScheduledEvent

Methods inherited from class GenericGuildEvent

getGuild

Methods inherited from class Event

getJDA, getRawData, getResponseNumber

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

ScheduledEventUpdateDescriptionEvent

public ScheduledEventUpdateDescriptionEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 ScheduledEvent scheduledEvent,
 @Nullable
 String previous)

Method Details

getOldDescription

@Nullable
public String getOldDescription()

The old description.

Returns:

The old description, or null if no description was previously set.

getNewDescription

@Nullable
public String getNewDescription()

The new description.

Returns:

The new description, or null if the description was removed.