Package net.dv8tion.jda.internal.managers

Class ScheduledEventManagerImpl

java.lang.Object

net.dv8tion.jda.internal.requests.RestActionImpl<Void>

net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl<Void>

net.dv8tion.jda.internal.managers.ManagerBase<ScheduledEventManager>

net.dv8tion.jda.internal.managers.ScheduledEventManagerImpl

All Implemented Interfaces:

Manager<ScheduledEventManager>, ScheduledEventManager, RestAction<Void>, AuditableRestAction<Void>

public class ScheduledEventManagerImpl
extends ManagerBase<ScheduledEventManager>
implements ScheduledEventManager

Field Summary

Fields inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

LOG

Fields inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

MAX_REASON_LENGTH

Fields inherited from interface net.dv8tion.jda.api.managers.ScheduledEventManager

DESCRIPTION, END_TIME, IMAGE, LOCATION, NAME, START_TIME, STATUS

Constructor Summary

Constructors

Constructor	Description
ScheduledEventManagerImpl(ScheduledEvent event)

Method Summary

Modifier and Type	Method	Description
ScheduledEvent	getScheduledEvent()	The target ScheduledEvent for this manager
ScheduledEventManager	setDescription(String description)	Sets the description of the selected ScheduledEvent.
ScheduledEventManager	setEndTime(TemporalAccessor endTime)	Sets the time that the selected ScheduledEvent should end at.
ScheduledEventManager	setImage(Icon icon)	Sets the cover image for the new ScheduledEvent.
ScheduledEventManager	setLocation(String location)	Sets the location of the selected ScheduledEvent to take place externally, or not in a specific GuildChannel.
ScheduledEventManager	setLocation(GuildChannel channel)	Sets the location of the selected ScheduledEvent to take place in the specified GuildChannel.
ScheduledEventManagerImpl	setName(String name)	Sets the name of the selected ScheduledEvent
ScheduledEventManager	setStartTime(TemporalAccessor startTime)	Sets the time that the selected ScheduledEvent should start at.
ScheduledEventManager	setStatus(ScheduledEvent.Status newStatus)	Sets the status of the event.

Methods inherited from class net.dv8tion.jda.internal.managers.ManagerBase

complete, deadline, isPermissionChecksEnabled, queue, reset, reset, reset, setCheck, setPermissionChecksEnabled, timeout

Methods inherited from class net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl

reason

Methods inherited from class net.dv8tion.jda.internal.requests.RestActionImpl

getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, setDefaultFailure, setDefaultSuccess, setDefaultTimeout, setErrorMapper, setPassContext, submit

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction

reason

Methods inherited from interface net.dv8tion.jda.api.managers.Manager

deadline, reset, setCheck, timeout

Methods inherited from interface net.dv8tion.jda.api.requests.RestAction

addCheck, and, and, complete, complete, completeAfter, delay, delay, delay, delay, flatMap, flatMap, getCheck, getJDA, map, mapToResult, onErrorFlatMap, onErrorFlatMap, onErrorMap, onErrorMap, onSuccess, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter, zip

Methods inherited from interface net.dv8tion.jda.api.managers.ScheduledEventManager

getGuild, reset, reset

Constructor Details

ScheduledEventManagerImpl

public ScheduledEventManagerImpl(ScheduledEvent event)

Method Details

getScheduledEvent

@Nonnull
public ScheduledEvent getScheduledEvent()

Description copied from interface: ScheduledEventManager

The target ScheduledEvent for this manager

Specified by:

getScheduledEvent in interface ScheduledEventManager

setName

@Nonnull
@CheckReturnValue
public ScheduledEventManagerImpl setName(@Nonnull
 String name)

Description copied from interface: ScheduledEventManager

Sets the name of the selected ScheduledEvent

Specified by:

setName in interface ScheduledEventManager

Parameters:

name - The new name for the selected ScheduledEvent

Returns:

ScheduledEventManager for chaining convenience

setDescription

@Nonnull
public ScheduledEventManager setDescription(@Nullable
 String description)

Description copied from interface: ScheduledEventManager

Sets the description of the selected ScheduledEvent. This field may include markdown.

Specified by:

setDescription in interface ScheduledEventManager

Parameters:

description - The new description for the selected ScheduledEvent, or null to reset the description

Returns:

ScheduledEventManager for chaining convenience

setImage

@Nonnull
public ScheduledEventManager setImage(@Nullable
 Icon icon)

Description copied from interface: ScheduledEventManager

Sets the cover image for the new ScheduledEvent.

Specified by:

setImage in interface ScheduledEventManager

Parameters:

icon - The cover image for the new ScheduledEvent, or null for no cover image.

Returns:

ScheduledEventManager for chaining convenience

setLocation

@Nonnull
public ScheduledEventManager setLocation(@Nonnull
 GuildChannel channel)

Description copied from interface: ScheduledEventManager

Sets the location of the selected ScheduledEvent to take place in the specified GuildChannel.

This will change the event's type to ScheduledEvent.Type.STAGE_INSTANCE or ScheduledEvent.Type.VOICE, which are the only supported channel types for the location of scheduled events currently.

Specified by:

setLocation in interface ScheduledEventManager

Parameters:

channel - The GuildChannel that the selected ScheduledEvent is set to take place in.

Returns:

ScheduledEventManager for chaining convenience

setLocation

@Nonnull
public ScheduledEventManager setLocation(@Nonnull
 String location)

Description copied from interface: ScheduledEventManager

Sets the location of the selected ScheduledEvent to take place externally, or not in a specific GuildChannel. Please note that an event is required to have an end time set if the location is external.

This will change the event's type to ScheduledEvent.Type.EXTERNAL

Specified by:

setLocation in interface ScheduledEventManager

Parameters:

location - The location that the selected ScheduledEvent is set to take place at.

Returns:

ScheduledEventManager for chaining convenience

See Also:

• ScheduledEventManager.setEndTime(TemporalAccessor)
• ScheduledEventManager.setLocation(GuildChannel)

setStartTime

@Nonnull
public ScheduledEventManager setStartTime(@Nonnull
 TemporalAccessor startTime)

Description copied from interface: ScheduledEventManager

Sets the time that the selected ScheduledEvent should start at. Events of Type.EXTERNAL will automatically start at this time. Events of Type.STAGE_INSTANCE and Type.VOICE need to be manually started. If the ScheduledEvent has not begun after its scheduled start time, it will be automatically cancelled after a few hours.

Specified by:

setStartTime in interface ScheduledEventManager

Parameters:

startTime - The time that the selected ScheduledEvent is set to start at.

Returns:

ScheduledEventManager for chaining convenience

See Also:

• ScheduledEventManager.setEndTime(TemporalAccessor)

setEndTime

@Nonnull
public ScheduledEventManager setEndTime(@Nonnull
 TemporalAccessor endTime)

Description copied from interface: ScheduledEventManager

Sets the time that the selected ScheduledEvent should end at. Events of Type.EXTERNAL will automatically end at this time, and events of Type.STAGE_INSTANCE and Type.VOICE will end a few minutes after the last person has left the channel.

Specified by:

setEndTime in interface ScheduledEventManager

Parameters:

endTime - The time that the selected ScheduledEvent is set to end at.

Returns:

ScheduledEventManager for chaining convenience

See Also:

• ScheduledEventManager.setStartTime(TemporalAccessor)

setStatus

@Nonnull
public ScheduledEventManager setStatus(@Nonnull
 ScheduledEvent.Status newStatus)

Description copied from interface: ScheduledEventManager

Sets the status of the event. This method may be used to start, end or cancel an event but can only be used to complete one of the following transitions:

1. Status.SCHEDULED to Status.ACTIVE
2. Status.SCHEDULED to Status.CANCELED
3. Status.ACTIVE to Status.COMPLETED

Specified by:

setStatus in interface ScheduledEventManager

Parameters:

newStatus - The new status

Returns:

ScheduledEventManager for chaining convenience

See Also:

• ScheduledEventManager.getScheduledEvent()
• ScheduledEvent.getStatus()