Package net.dv8tion.jda.internal.entities

Class ScheduledEventImpl

java.lang.Object

net.dv8tion.jda.internal.entities.ScheduledEventImpl

All Implemented Interfaces:

Comparable<ScheduledEvent>, ISnowflake, ScheduledEvent

public class ScheduledEventImpl
extends Object
implements ScheduledEvent

Nested Class Summary

Nested classes/interfaces inherited from interface net.dv8tion.jda.api.entities.ScheduledEvent

ScheduledEvent.Status, ScheduledEvent.Type

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.ScheduledEvent

IMAGE_URL, JUMP_URL, MAX_DESCRIPTION_LENGTH, MAX_LOCATION_LENGTH, MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor	Description
ScheduledEventImpl(long id, Guild guild)

Method Summary

Modifier and Type	Method	Description
int	compareTo(ScheduledEvent scheduledEvent)	Compares two ScheduledEvent objects based on their scheduled start times.
AuditableRestAction<Void>	delete()	Deletes this Scheduled Event.
boolean	equals(Object o)
GuildChannelUnion	getChannel()	The guild channel the event is set to take place in.
User	getCreator()	The user who originally created the event.
long	getCreatorIdLong()	The ID of the user who originally created this event.
String	getDescription()	The description of the event.
OffsetDateTime	getEndTime()	The time the event is set to end at.
Guild	getGuild()	The guild that this event was created in
long	getIdLong()	The Snowflake id of this entity.
String	getImageUrl()	The cover image url of the event.
int	getInterestedUserCount()	The amount of users who are interested in attending the event.
String	getJumpUrl()	Returns the jump-to URL of the event.
String	getLocation()	The location the event is set to take place in.
ScheduledEventManager	getManager()	The ScheduledEventManager for this event.
String	getName()	The name of the event.
OffsetDateTime	getStartTime()	The time the event is set to start at.
ScheduledEvent.Status	getStatus()	The status of the scheduled event.
ScheduledEvent.Type	getType()	The type of the scheduled event.
int	hashCode()
ScheduledEventMembersPaginationAction	retrieveInterestedMembers()	A PaginationAction implementation that allows to iterate over all Members interested in this Event.
ScheduledEventImpl	setCreator(User creator)
ScheduledEventImpl	setCreatorId(long creatorId)
ScheduledEventImpl	setDescription(String description)
ScheduledEventImpl	setEndTime(OffsetDateTime endTime)
ScheduledEventImpl	setImage(String image)
ScheduledEventImpl	setInterestedUserCount(int interestedUserCount)
ScheduledEventImpl	setLocation(String location)
ScheduledEventImpl	setName(String name)
ScheduledEventImpl	setStartTime(OffsetDateTime startTime)
ScheduledEventImpl	setStatus(ScheduledEvent.Status status)
ScheduledEventImpl	setType(ScheduledEvent.Type type)
String	toString()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.ISnowflake

getId, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.ScheduledEvent

getCreatorId, getImage, getJDA

Constructor Details

ScheduledEventImpl

public ScheduledEventImpl(long id,
 Guild guild)

Method Details

getName

@Nonnull
public String getName()

Description copied from interface: ScheduledEvent

The name of the event.

Specified by:

getName in interface ScheduledEvent

Returns:

The event's name

getDescription

@Nullable
public String getDescription()

Description copied from interface: ScheduledEvent

The description of the event.

Specified by:

getDescription in interface ScheduledEvent

Returns:

The description, or null if none is specified

getImageUrl

@Nullable
public String getImageUrl()

Description copied from interface: ScheduledEvent

The cover image url of the event.

Links to a potentially heavily compressed image. You can append a size parameter to the URL if needed. Example: ?size=4096

Specified by:

getImageUrl in interface ScheduledEvent

Returns:

The image url, or null if none is specified

getCreator

@Nullable
public User getCreator()

Description copied from interface: ScheduledEvent

The user who originally created the event.

May return null if user has deleted their account, the User object is not cached or the event was created before Discord started keeping track of event creators on October 21st, 2021.

Specified by:

getCreator in interface ScheduledEvent

Returns:

User object representing the event's creator or null.

See Also:

• ScheduledEvent.getCreatorId()
• ScheduledEvent.getCreatorIdLong()

getCreatorIdLong

public long getCreatorIdLong()

Description copied from interface: ScheduledEvent

The ID of the user who originally created this event.

This method may return 0 if the event was created before Discord started keeping track of event creators on October 21st, 2021.

Specified by:

getCreatorIdLong in interface ScheduledEvent

Returns:

The ID of the user who created this event, or 0 if no user is associated with creating this event.

See Also:

• ScheduledEvent.getCreatorId()
• ScheduledEvent.getCreator()

getStatus

@Nonnull
public ScheduledEvent.Status getStatus()

Description copied from interface: ScheduledEvent

The status of the scheduled event.

Specified by:

getStatus in interface ScheduledEvent

Returns:

The status, or ScheduledEvent.Status.UNKNOWN if the status is unknown to JDA.

getType

@Nonnull
public ScheduledEvent.Type getType()

Description copied from interface: ScheduledEvent

The type of the scheduled event.

Specified by:

getType in interface ScheduledEvent

Returns:

The type, or ScheduledEvent.Type.UNKNOWN if the type is unknown to JDA.

getStartTime

@Nonnull
public OffsetDateTime getStartTime()

Description copied from interface: ScheduledEvent

The time the event is set to start at.

Specified by:

getStartTime in interface ScheduledEvent

Returns:

The time the event is set to start at

See Also:

• ScheduledEvent.getEndTime()

getEndTime

@Nullable
public OffsetDateTime getEndTime()

Description copied from interface: ScheduledEvent

The time the event is set to end at.
The end time is only required for external events, which are events that are not associated with a stage or voice channel.

Specified by:

getEndTime in interface ScheduledEvent

Returns:

The time the event is set to end at. This can't be null for events of ScheduledEvent.Type.EXTERNAL, but can be null for other types.

See Also:

• ScheduledEvent.getType()
• ScheduledEvent.getStartTime()

getChannel

@Nullable
public GuildChannelUnion getChannel()

Description copied from interface: ScheduledEvent

The guild channel the event is set to take place in.
Note that this method is only applicable to events which are not of ScheduledEvent.Type.STAGE_INSTANCE or ScheduledEvent.Type.VOICE.

Specified by:

getChannel in interface ScheduledEvent

Returns:

The guild channel, or null if the guild channel was deleted or if the event is of ScheduledEvent.Type.EXTERNAL

See Also:

• ScheduledEvent.getType()
• ScheduledEvent.getLocation()

getLocation

@Nonnull
public String getLocation()

Description copied from interface: ScheduledEvent

The location the event is set to take place in. This will return the channel id for ScheduledEvent.Type.STAGE_INSTANCE and ScheduledEvent.Type.VOICE.

Specified by:

getLocation in interface ScheduledEvent

Returns:

The channel id or the external location of the event

See Also:

• ScheduledEvent.getType()
• ScheduledEvent.getChannel()

getJumpUrl

@Nonnull
public String getJumpUrl()

Description copied from interface: ScheduledEvent

Returns the jump-to URL of the event. Clicking this URL in the Discord client will open the event.

Specified by:

getJumpUrl in interface ScheduledEvent

Returns:

A String representing the jump-to URL of the event.

getInterestedUserCount

public int getInterestedUserCount()

Description copied from interface: ScheduledEvent

The amount of users who are interested in attending the event.

This method only returns the cached count, and may not be consistent with the live count. Discord may additionally not provide an interested user count for some ScheduledEvent objects returned from the Guild's or JDA's cache, and this method may return -1 as a result. However, event's retrieved using Guild.retrieveScheduledEventById(long) will always contain an interested user count.

Specified by:

getInterestedUserCount in interface ScheduledEvent

Returns:

The amount of users who are interested in attending the event

See Also:

• Guild.retrieveScheduledEventById(long)
• Guild.retrieveScheduledEventById(String)

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: ScheduledEvent

The guild that this event was created in

Specified by:

getGuild in interface ScheduledEvent

Returns:

The guild

getIdLong

public long getIdLong()

Description copied from interface: ISnowflake

The Snowflake id of this entity. This is unique to every entity and will never change.

Specified by:

getIdLong in interface ISnowflake

Returns:

Long containing the Id.

getManager

@Nonnull
public ScheduledEventManager getManager()

Description copied from interface: ScheduledEvent

The ScheduledEventManager for this event.
In the ScheduledEventManager, you can modify all values and also start, end, or cancel events.
You can modify multiple fields in one request by chaining setters before calling RestAction.queue().

Specified by:

getManager in interface ScheduledEvent

Returns:

The ScheduledEventManager of this event

delete

@Nonnull
public AuditableRestAction<Void> delete()

Description copied from interface: ScheduledEvent

Deletes this Scheduled Event.

Possible ErrorResponses include:

• UNKNOWN_SCHEDULED_EVENT
  If the the event was already deleted.
• MISSING_PERMISSIONS
  The send request was attempted after the account lost Permission.MANAGE_EVENTS in the guild.
• MISSING_ACCESS
  If we were removed from the Guild

Specified by:

delete in interface ScheduledEvent

Returns:

AuditableRestAction

retrieveInterestedMembers

@Nonnull
public ScheduledEventMembersPaginationAction retrieveInterestedMembers()

Description copied from interface: ScheduledEvent

A PaginationAction implementation that allows to iterate over all Members interested in this Event.
This iterates in ascending order by member id.

Possible ErrorResponses include:

• ErrorResponse.UNKNOWN_SCHEDULED_EVENT
  If the the event was already deleted.
• MISSING_ACCESS
  If we were removed from the Guild or can't view the events channel (Location)

Specified by:

retrieveInterestedMembers in interface ScheduledEvent

Returns:

ScheduledEventMembersPaginationAction

setName

public ScheduledEventImpl setName(String name)

setType

public ScheduledEventImpl setType(ScheduledEvent.Type type)

setLocation

public ScheduledEventImpl setLocation(String location)

setDescription

public ScheduledEventImpl setDescription(String description)

setImage

public ScheduledEventImpl setImage(String image)

setCreatorId

public ScheduledEventImpl setCreatorId(long creatorId)

setCreator

public ScheduledEventImpl setCreator(User creator)

setStatus

public ScheduledEventImpl setStatus(ScheduledEvent.Status status)

setStartTime

public ScheduledEventImpl setStartTime(OffsetDateTime startTime)

setEndTime

public ScheduledEventImpl setEndTime(OffsetDateTime endTime)

setInterestedUserCount

public ScheduledEventImpl setInterestedUserCount(int interestedUserCount)

compareTo

public int compareTo(@Nonnull
 ScheduledEvent scheduledEvent)

Description copied from interface: ScheduledEvent

Compares two ScheduledEvent objects based on their scheduled start times.
If two events are set to start at the same time, the comparison will be made based on their snowflake ID.

Specified by:

compareTo in interface Comparable<ScheduledEvent>

Specified by:

compareTo in interface ScheduledEvent

Parameters:

scheduledEvent - The provided scheduled event

Returns:

A negative number if the original event (which is the event that the compareTo method is called upon) starts sooner than the provided event, or positive if it will start later than the provided event. If both events are set to start at the same time, then the result will be negative if the original event's snowflake ID is less than the provided event's ID, positive if it is greater than, or 0 if they are the same.

See Also:

• Comparable.compareTo(Object)
• ScheduledEvent.getStartTime()
• ISnowflake.getIdLong()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object