Package net.dv8tion.jda.internal.requests.restaction

Class ScheduledEventActionImpl

java.lang.Object

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

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

net.dv8tion.jda.internal.requests.restaction.ScheduledEventActionImpl

All Implemented Interfaces:

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

public class ScheduledEventActionImpl
extends AuditableRestActionImpl<ScheduledEvent>
implements ScheduledEventAction

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

Constructor Summary

Constructors

Constructor	Description
ScheduledEventActionImpl(String name, String location, TemporalAccessor startTime, TemporalAccessor endTime, Guild guild)
ScheduledEventActionImpl(String name, GuildChannel channel, TemporalAccessor startTime, Guild guild)

Method Summary

Modifier and Type	Method	Description
ScheduledEventActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
Guild	getGuild()	The guild to create the ScheduledEvent in
ScheduledEventActionImpl	reason(String reason)	Applies the specified reason as audit-log reason field.
ScheduledEventActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
ScheduledEventActionImpl	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.
ScheduledEventActionImpl	setName(String name)	Sets the name for the new ScheduledEvent.
ScheduledEventAction	setStartTime(TemporalAccessor startTime)	Sets the time that the new ScheduledEvent will start at.
ScheduledEventActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

complete, getCheck, getDefaultFailure, getDefaultSuccess, getDefaultTimeout, getJDA, handleResponse, isPassContext, priority, queue, 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.FluentAuditableRestAction

addCheck

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

Constructor Details

ScheduledEventActionImpl

public ScheduledEventActionImpl(String name,
 String location,
 TemporalAccessor startTime,
 TemporalAccessor endTime,
 Guild guild)

ScheduledEventActionImpl

public ScheduledEventActionImpl(String name,
 GuildChannel channel,
 TemporalAccessor startTime,
 Guild guild)

Method Details

setCheck

@Nonnull
public ScheduledEventActionImpl setCheck(BooleanSupplier checks)

Description copied from interface: RestAction

Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates to false or throws an exception this will not be finished. When an exception is thrown from the supplier it will be provided to the failure callback.

Specified by:

setCheck in interface AuditableRestAction<ScheduledEvent>

Specified by:

setCheck in interface FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>

Specified by:

setCheck in interface RestAction<ScheduledEvent>

Overrides:

setCheck in class AuditableRestActionImpl<ScheduledEvent>

Parameters:

checks - The checks to run before executing the request, or null to run no checks

Returns:

The current RestAction for chaining convenience

See Also:

• RestAction.getCheck()
• RestAction.addCheck(BooleanSupplier)

timeout

@Nonnull
public ScheduledEventActionImpl timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: AuditableRestAction

Timeout for this RestAction instance.
If the request doesn't get executed within the timeout it will fail.

When a RestAction times out, it will fail with a TimeoutException. This is the same as deadline(System.currentTimeMillis() + unit.toMillis(timeout)).

Example

 action.timeout(10, TimeUnit.SECONDS) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

timeout in interface AuditableRestAction<ScheduledEvent>

Specified by:

timeout in interface FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>

Specified by:

timeout in interface RestAction<ScheduledEvent>

Overrides:

timeout in class AuditableRestActionImpl<ScheduledEvent>

Parameters:

timeout - The timeout to use

unit - Unit for the timeout value

Returns:

The same RestAction instance with the applied timeout

See Also:

• RestAction.setDefaultTimeout(long, TimeUnit)

deadline

@Nonnull
public ScheduledEventActionImpl deadline(long timestamp)

Description copied from interface: RestAction

Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
If the deadline is reached, the request will fail with a TimeoutException.

This does not mean that the request will immediately timeout when the deadline is reached. JDA will check the deadline right before executing the request or within intervals in a worker thread. This only means the request will timeout if the deadline has passed.

Example

 action.deadline(System.currentTimeMillis() + 10000) // 10 seconds from now
       .queueAfter(20, SECONDS); // request will not be executed within deadline and timeout immediately after 20 seconds
 

Specified by:

deadline in interface AuditableRestAction<ScheduledEvent>

Specified by:

deadline in interface FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>

Specified by:

deadline in interface RestAction<ScheduledEvent>

Overrides:

deadline in class AuditableRestActionImpl<ScheduledEvent>

Parameters:

timestamp - Millisecond timestamp at which the request will timeout

Returns:

The same RestAction with the applied deadline

See Also:

• RestAction.timeout(long, TimeUnit)
• RestAction.setDefaultTimeout(long, TimeUnit)

reason

@Nonnull
public ScheduledEventActionImpl reason(@Nullable
 String reason)

Description copied from interface: AuditableRestAction

Applies the specified reason as audit-log reason field.
When the provided reason is empty or null it will be treated as not set. If the provided reason is longer than 512<T> characters, it will be truncated to fit the limit.

Reasons for any AuditableRestAction may be retrieved via AuditLogEntry.getReason() in iterable AuditLogPaginationActions from Guild.retrieveAuditLogs()! For guild bans, this is also accessible via Guild.Ban.getReason().

This will specify the reason via the X-Audit-Log-Reason Request Header.

Specified by:

reason in interface AuditableRestAction<ScheduledEvent>

Specified by:

reason in interface FluentAuditableRestAction<ScheduledEvent,ScheduledEventAction>

Overrides:

reason in class AuditableRestActionImpl<ScheduledEvent>

Parameters:

reason - The reason for this action which should be logged in the Guild's AuditLogs (up to 512<T> characters)

Returns:

The current AuditableRestAction instance for chaining convenience

See Also:

• ThreadLocalReason

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: ScheduledEventAction

The guild to create the ScheduledEvent in

Specified by:

getGuild in interface ScheduledEventAction

Returns:

The guild

setName

@Nonnull
public ScheduledEventActionImpl setName(@Nullable
 String name)

Description copied from interface: ScheduledEventAction

Sets the name for the new ScheduledEvent.

Specified by:

setName in interface ScheduledEventAction

Parameters:

name - The name for the new ScheduledEvent

Returns:

The current ScheduledEventAction, for chaining convenience

setDescription

@Nonnull
@CheckReturnValue
public ScheduledEventActionImpl setDescription(@Nullable
 String description)

Description copied from interface: ScheduledEventAction

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

Specified by:

setDescription in interface ScheduledEventAction

Parameters:

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

Returns:

The current ScheduledEventAction, for chaining convenience

setStartTime

@Nonnull
public ScheduledEventAction setStartTime(@Nonnull
 TemporalAccessor startTime)

Description copied from interface: ScheduledEventAction

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.

Specified by:

setStartTime in interface ScheduledEventAction

Parameters:

startTime - The time that the new ScheduledEvent should start at

Returns:

The current ScheduledEventAction, for chaining convenience

setEndTime

@Nonnull
public ScheduledEventAction setEndTime(@Nullable
 TemporalAccessor endTime)

Description copied from interface: ScheduledEventAction

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.

Specified by:

setEndTime in interface ScheduledEventAction

Parameters:

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

Returns:

The current ScheduledEventAction, for chaining convenience

setImage

@Nonnull
public ScheduledEventAction setImage(@Nullable
 Icon icon)

Description copied from interface: ScheduledEventAction

Sets the cover image for the new ScheduledEvent.

Specified by:

setImage in interface ScheduledEventAction

Parameters:

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

Returns:

The current ScheduledEventAction, for chaining convenience