Package net.dv8tion.jda.api.requests.restaction

Interface ScheduledEventAction

All Superinterfaces:

AuditableRestAction<ScheduledEvent>, FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>, RestAction<ScheduledEvent>

public interface ScheduledEventAction
extends FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>

Extension of RestAction specifically designed to create a ScheduledEvent. This extension allows setting properties such as the name or description of an event before it is created.

Requirements
Events that are created are required to have a name, a location, and a start time. Depending on the type of location provided, an event will be of one of three different Types:

1. Type.STAGE_INSTANCE
   These events are set to take place inside of a StageChannel. The following permissions are required in the specified stage channel in order to create an event there:
   • Permission.MANAGE_EVENTS
   • Permission.MANAGE_CHANNEL
   • Permission.VOICE_MUTE_OTHERS
   • Permission.VOICE_MOVE_OTHERS
2. Type.VOICE
   These events are set to take place inside of a VoiceChannel. The following permissions are required in the specified voice channel in order to create an event there:
   • Permission.MANAGE_EVENTS
   • Permission.VIEW_CHANNEL
   • Permission.VOICE_CONNECT
3. Type.EXTERNAL
   These events are set to take place at an external location. Permission.MANAGE_EVENTS is required on the guild level in order to create this type of event. Additionally, an end time must also be specified.

See Also:

• Guild
• Guild.createScheduledEvent(String, String, OffsetDateTime, OffsetDateTime)
• Guild.createScheduledEvent(String, net.dv8tion.jda.api.entities.channel.middleman.GuildChannel, OffsetDateTime)

Field Summary

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

MAX_REASON_LENGTH

Method Summary

Modifier and Type	Method	Description
Guild	getGuild()	The guild to create the ScheduledEvent in
ScheduledEventAction	setDescription(String description)	Sets the description for the new ScheduledEvent.
ScheduledEventAction	setEndTime(TemporalAccessor endTime)	Sets the time that the new ScheduledEvent will end at.
ScheduledEventAction	setImage(Icon icon)	Sets the cover image for the new ScheduledEvent.
ScheduledEventAction	setName(String name)	Sets the name for the new ScheduledEvent.
ScheduledEventAction	setStartTime(TemporalAccessor startTime)	Sets the time that the new ScheduledEvent will start at.

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

addCheck, deadline, reason, setCheck, timeout

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

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

Method Details

getGuild

@Nonnull
Guild getGuild()

The guild to create the ScheduledEvent in

Returns:

The guild

setName

@Nonnull
@CheckReturnValue
ScheduledEventAction setName(@Nonnull
 String name)

Sets the name for the new ScheduledEvent.

Parameters:

name - The name for the new ScheduledEvent

Returns:

The current ScheduledEventAction, for chaining convenience

Throws:

IllegalArgumentException - If the new name is blank, empty, null, or contains more than 100 characters

setDescription

@Nonnull
@CheckReturnValue
ScheduledEventAction setDescription(@Nullable
 String description)

Sets the description for the new ScheduledEvent. This field may include markdown.

Parameters:

description - The description for the new ScheduledEvent, or null for no description

Returns:

The current ScheduledEventAction, for chaining convenience

Throws:

IllegalArgumentException - If the new description is longer than 1000 characters

setStartTime

@Nonnull
@CheckReturnValue
ScheduledEventAction setStartTime(@Nonnull
 TemporalAccessor startTime)

Sets the time that the new ScheduledEvent will start at. Events of Type.EXTERNAL will automatically start at this time, but events of Type.STAGE_INSTANCE and Type.VOICE will need to be manually started, and will automatically be cancelled a few hours after the start time if not.

Parameters:

startTime - The time that the new ScheduledEvent should start at

Returns:

The current ScheduledEventAction, for chaining convenience

Throws:

IllegalArgumentException - If the provided start time is null, or takes place after the end time

setEndTime

@Nonnull
@CheckReturnValue
ScheduledEventAction setEndTime(@Nullable
 TemporalAccessor endTime)

Sets the time that the new ScheduledEvent will 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 user has left the channel.

Note: Setting an end time is only possible for events of Type.EXTERNAL.

Parameters:

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

Returns:

The current ScheduledEventAction, for chaining convenience

Throws:

IllegalArgumentException - If the provided end time is chronologically set before the start time

setImage

@Nonnull
@CheckReturnValue
ScheduledEventAction 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:

The current ScheduledEventAction, for chaining convenience