All Superinterfaces:: AuditableRestAction<Void>, Manager<ScheduledEventManager>, RestAction<Void>

public interface ScheduledEventManager extends Manager<ScheduledEventManager>

The Manager is providing functionality to update one or more fields of a ScheduledEvent.
The manager may also be used to start, cancel or end events.

Example


 manager.setLocation("at the beach")
     .setStartTime(OffsetDateTime.now().plusHours(1))
     .setEndTime(OffsetDateTime.now().plusHours(3))
     .setName("Discussing Turtle Shells")
     .queue();

See Also:

ScheduledEvent.getManager()

Field Summary

Fields

Modifier and Type

Field

Description

static final long

DESCRIPTION

Used to reset the description field

static final long

END_TIME

Used to reset the end time field

static final long

IMAGE

Used to reset the image field

static final long

LOCATION

Used to reset the location field

static final long

NAME

Used to reset the name field

static final long

START_TIME

Used to reset the start time field

static final long

STATUS

Used to reset the status field

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

Modifier and Type

Method

Description

default Guild

getGuild()

The Guild this ScheduledEvent is in.

ScheduledEvent

getScheduledEvent()

The target ScheduledEvent for this manager

ScheduledEventManager

reset(long fields)

Resets the fields specified by the provided bit-flag pattern.

ScheduledEventManager

reset(long... fields)

Resets the fields specified by the provided bit-flag patterns.

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.

ScheduledEventManager

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 status)

Sets the status of the event.

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

Field Details
- NAME
  
  static final long NAME
  
  Used to reset the name field
  See Also:
  
  Constant Field Values
- DESCRIPTION
  
  static final long DESCRIPTION
  
  Used to reset the description field
  See Also:
  
  Constant Field Values
- LOCATION
  
  static final long LOCATION
  
  Used to reset the location field
  See Also:
  
  Constant Field Values
- START_TIME
  
  static final long START_TIME
  
  Used to reset the start time field
  See Also:
  
  Constant Field Values
- END_TIME
  
  static final long END_TIME
  
  Used to reset the end time field
  See Also:
  
  Constant Field Values
- IMAGE
  
  static final long IMAGE
  
  Used to reset the image field
  See Also:
  
  Constant Field Values
- STATUS
  
  static final long STATUS
  
  Used to reset the status field
  See Also:
  
  Constant Field Values
Method Details
- reset
  
  @Nonnull ScheduledEventManager reset(long fields)
  Resets the fields specified by the provided bit-flag pattern. You can specify a combination by using a bitwise OR concat of the flag constants.
  Example: manager.reset(ScheduledEventManager.DESCRIPTION | ScheduledEventManager.END_TIME);
  Flag Constants:
  
  NAME
  
  DESCRIPTION
  
  LOCATION
  
  START_TIME
  
  END_TIME
  
  IMAGE
  
  STATUS
  Specified by:
  
  reset in interface Manager<ScheduledEventManager>
  
  Parameters:
  
  fields - Integer value containing the flags to reset.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
- reset
  
  @Nonnull ScheduledEventManager reset(long... fields)
  Resets the fields specified by the provided bit-flag patterns. You can specify a combination by using a bitwise OR concat of the flag constants.
  Example: manager.reset(ScheduledEventManager.DESCRIPTION, ScheduledEventManager.END_TIME);
  Flag Constants:
  
  NAME
  
  DESCRIPTION
  
  LOCATION
  
  START_TIME
  
  END_TIME
  
  IMAGE
  
  STATUS
  Specified by:
  
  reset in interface Manager<ScheduledEventManager>
  
  Parameters:
  
  fields - Integer values containing the flags to reset.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
- getScheduledEvent
  
  @Nonnull ScheduledEvent getScheduledEvent()
  
  The target ScheduledEvent for this manager
- getGuild
  
  @Nonnull default Guild getGuild()
  
  The Guild this ScheduledEvent is in.
  This is logically the same as calling getScheduledEvent().getGuild()
  
  Returns:
  
  The parent Guild
- setName
  
  @Nonnull @CheckReturnValue ScheduledEventManager setName(@Nonnull String name)
  
  Sets the name of the selected ScheduledEvent
  
  Parameters:
  
  name - The new name for the selected ScheduledEvent
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException - If the new name is blank, empty, null, or longer than 100 characters
- setDescription
  
  @Nonnull @CheckReturnValue ScheduledEventManager setDescription(@Nullable String description)
  
  Sets the description of the selected ScheduledEvent. This field may include markdown.
  
  Parameters:
  
  description - The new description for the selected ScheduledEvent, or null to reset the description
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException - If the new description is longer than 1000 characters
- setImage
  
  @Nonnull @CheckReturnValue ScheduledEventManager setImage(@Nullable Icon icon)
  
  Sets the cover image for the new ScheduledEvent.
  
  Parameters:
  
  icon - The cover image for the new ScheduledEvent, or null for no cover image.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
- setLocation
  
  @Nonnull @CheckReturnValue ScheduledEventManager setLocation(@Nonnull GuildChannel channel)
  
  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.
  Parameters:
  
  channel - The GuildChannel that the selected ScheduledEvent is set to take place in.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException -
  
  If the provided GuildChannel is null
  
  If the provided GuildChannel is not from the same guild
  
  If the provided GuildChannel is not a StageChannel or VoiceChannel
  
  InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_EVENTS, Permission.MANAGE_CHANNEL, Permission.VOICE_MUTE_OTHERS, or Permission.VOICE_MOVE_OTHERS, in the provided channel.
- setLocation
  
  @Nonnull @CheckReturnValue ScheduledEventManager setLocation(@Nonnull String location)
  
  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
  Parameters:
  
  location - The location that the selected ScheduledEvent is set to take place at.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException - If the provided location is blank, empty, null, or longer than 100
  
  IllegalStateException - If the selected ScheduledEvent does not have an end time
  
  InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_EVENTS
  
  See Also:
  
  setEndTime(TemporalAccessor)
  
  setLocation(GuildChannel)
- setStartTime
  
  @Nonnull @CheckReturnValue ScheduledEventManager setStartTime(@Nonnull TemporalAccessor startTime)
  
  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.
  Parameters:
  
  startTime - The time that the selected ScheduledEvent is set to start at.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException -
  
  If the provided start time is null
  
  If the provided start time is before the end time
  
  If the provided start time is before the current time
  
  See Also:
  
  setEndTime(TemporalAccessor)
- setEndTime
  
  @Nonnull @CheckReturnValue ScheduledEventManager setEndTime(@Nonnull TemporalAccessor endTime)
  
  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.
  Parameters:
  
  endTime - The time that the selected ScheduledEvent is set to end at.
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalArgumentException -
  
  If the provided end time is before the start time
  
  If the provided end time is null
  
  See Also:
  
  setStartTime(TemporalAccessor)
- setStatus
  
  @Nonnull @CheckReturnValue ScheduledEventManager setStatus(@Nonnull ScheduledEvent.Status status)
  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:
  
  Status.SCHEDULED to Status.ACTIVE
  
  Status.SCHEDULED to Status.CANCELED
  
  Status.ACTIVE to Status.COMPLETED
  Parameters:
  
  status - The new status
  
  Returns:
  
  ScheduledEventManager for chaining convenience
  
  Throws:
  
  IllegalStateException - If the transition between statuses does not follow one of the three documented above.
  
  IllegalArgumentException - If the provided status is null
  
  See Also:
  
  getScheduledEvent()
  
  ScheduledEvent.getStatus()

Interface ScheduledEventManager

Field Summary

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

Method Summary

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

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

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

Field Details

NAME

DESCRIPTION

LOCATION

START_TIME

END_TIME

IMAGE

STATUS

Method Details

reset

reset

getScheduledEvent

getGuild

setName

setDescription

setImage

setLocation

setLocation

setStartTime

setEndTime

setStatus