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

Class ScheduledEventUpdateStatusEvent

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<ScheduledEvent.Status>

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

All Implemented Interfaces:

GenericEvent, UpdateEvent<ScheduledEvent,ScheduledEvent.Status>

public class ScheduledEventUpdateStatusEvent
extends GenericScheduledEventUpdateEvent<ScheduledEvent.Status>

Indicates that the status of a ScheduledEvent has changed. The status of a ScheduledEvent represents if it is currently active, canceled, or completed.

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

Identifier: status

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
ScheduledEventUpdateStatusEvent(JDA api, long responseNumber, ScheduledEvent scheduledEvent, ScheduledEvent.Status previous)

Method Summary

Modifier and Type	Method	Description
ScheduledEvent.Status	getNewStatus()	The new status.
ScheduledEvent.Status	getNewValue()	The new value
ScheduledEvent.Status	getOldStatus()	The old status.
ScheduledEvent.Status	getOldValue()	The old value

Methods inherited from class net.dv8tion.jda.api.events.guild.scheduledevent.update.GenericScheduledEventUpdateEvent

getEntity, getPropertyIdentifier, toString

Methods inherited from class net.dv8tion.jda.api.events.guild.scheduledevent.GenericScheduledEventGatewayEvent

getScheduledEvent

Methods inherited from class net.dv8tion.jda.api.events.guild.GenericGuildEvent

getGuild

Methods inherited from class net.dv8tion.jda.api.events.Event

getJDA, getRawData, getResponseNumber

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.events.GenericEvent

getJDA, getRawData, getResponseNumber

Methods inherited from interface net.dv8tion.jda.api.events.UpdateEvent

getEntityType

Field Details

IDENTIFIER

public static final String IDENTIFIER

See Also:

• Constant Field Values

Constructor Details

ScheduledEventUpdateStatusEvent

public ScheduledEventUpdateStatusEvent(@Nonnull
 JDA api,
 long responseNumber,
 @Nonnull
 ScheduledEvent scheduledEvent,
 @Nonnull
 ScheduledEvent.Status previous)

Method Details

getOldStatus

@Nonnull
public ScheduledEvent.Status getOldStatus()

The old status.

Returns:

The old status

getNewStatus

@Nonnull
public ScheduledEvent.Status getNewStatus()

The new status.

Returns:

The new status

getOldValue

@Nonnull
public ScheduledEvent.Status getOldValue()

Description copied from interface: UpdateEvent

The old value

Specified by:

getOldValue in interface UpdateEvent<ScheduledEvent,ScheduledEvent.Status>

Overrides:

getOldValue in class GenericScheduledEventUpdateEvent<ScheduledEvent.Status>

Returns:

The old value

getNewValue

@Nonnull
public ScheduledEvent.Status getNewValue()

Description copied from interface: UpdateEvent

The new value

Specified by:

getNewValue in interface UpdateEvent<ScheduledEvent,ScheduledEvent.Status>

Overrides:

getNewValue in class GenericScheduledEventUpdateEvent<ScheduledEvent.Status>

Returns:

The new value