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

Class InviteActionImpl

java.lang.Object

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

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

net.dv8tion.jda.internal.requests.restaction.InviteActionImpl

All Implemented Interfaces:

RestAction<Invite>, AuditableRestAction<Invite>, InviteAction

public class InviteActionImpl
extends AuditableRestActionImpl<Invite>
implements InviteAction

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
InviteActionImpl(JDA api, String channelId)

Method Summary

Modifier and Type	Method	Description
InviteActionImpl	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
InviteActionImpl	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
InviteActionImpl	setMaxAge(Integer maxAge)	Sets the max age in seconds for the invite.
InviteActionImpl	setMaxAge(Long maxAge, TimeUnit timeUnit)	Sets the max age for the invite.
InviteActionImpl	setMaxUses(Integer maxUses)	Sets the max uses for the invite.
InviteAction	setTargetApplication(long applicationId)	Sets the id of the targeted application.
InviteAction	setTargetStream(long userId)	Sets the user whose stream to target for this invite.
InviteActionImpl	setTemporary(Boolean temporary)	Sets whether the invite should only grant temporary membership.
InviteActionImpl	setUnique(Boolean unique)	Sets whether discord should reuse a similar invite.
InviteActionImpl	timeout(long timeout, TimeUnit unit)	Timeout for this RestAction instance.

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

reason

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.AuditableRestAction

reason

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

setTargetApplication, setTargetStream, setTargetStream, setTargetStream

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

Constructor Details

InviteActionImpl

public InviteActionImpl(JDA api,
 String channelId)

Method Details

setCheck

@Nonnull
public InviteActionImpl 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<Invite>

Specified by:

setCheck in interface InviteAction

Specified by:

setCheck in interface RestAction<Invite>

Overrides:

setCheck in class AuditableRestActionImpl<Invite>

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 InviteActionImpl 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<Invite>

Specified by:

timeout in interface InviteAction

Specified by:

timeout in interface RestAction<Invite>

Overrides:

timeout in class AuditableRestActionImpl<Invite>

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 InviteActionImpl 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<Invite>

Specified by:

deadline in interface InviteAction

Specified by:

deadline in interface RestAction<Invite>

Overrides:

deadline in class AuditableRestActionImpl<Invite>

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)

setMaxAge

@Nonnull
@CheckReturnValue
public InviteActionImpl setMaxAge(Integer maxAge)

Description copied from interface: InviteAction

Sets the max age in seconds for the invite. Set this to 0 if the invite should never expire. Default is 86400 (24 hours). null will reset this to the default value.

Specified by:

setMaxAge in interface InviteAction

Parameters:

maxAge - The max age for this invite or null to use the default value.

Returns:

The current InviteAction for chaining.

setMaxAge

@Nonnull
@CheckReturnValue
public InviteActionImpl setMaxAge(Long maxAge,
 @Nonnull
 TimeUnit timeUnit)

Description copied from interface: InviteAction

Sets the max age for the invite. Set this to 0 if the invite should never expire. Default is 86400 (24 hours). null will reset this to the default value.

Specified by:

setMaxAge in interface InviteAction

Parameters:

maxAge - The max age for this invite or null to use the default value.

timeUnit - The TimeUnit type of maxAge.

Returns:

The current InviteAction for chaining.

setMaxUses

@Nonnull
@CheckReturnValue
public InviteActionImpl setMaxUses(Integer maxUses)

Description copied from interface: InviteAction

Sets the max uses for the invite. Set this to 0 if the invite should have unlimited uses. Default is 0. null will reset this to the default value.

Specified by:

setMaxUses in interface InviteAction

Parameters:

maxUses - The max uses for this invite or null to use the default value.

Returns:

The current InviteAction for chaining.

setTemporary

@Nonnull
@CheckReturnValue
public InviteActionImpl setTemporary(Boolean temporary)

Description copied from interface: InviteAction

Sets whether the invite should only grant temporary membership. Default is false.

Specified by:

setTemporary in interface InviteAction

Parameters:

temporary - Whether the invite should only grant temporary membership or null to use the default value.

Returns:

The current InviteAction for chaining.

setUnique

@Nonnull
@CheckReturnValue
public InviteActionImpl setUnique(Boolean unique)

Description copied from interface: InviteAction

Sets whether discord should reuse a similar invite. Default is false.

Specified by:

setUnique in interface InviteAction

Parameters:

unique - Whether discord should reuse a similar invite or null to use the default value.

Returns:

The current InviteAction for chaining.

setTargetApplication

@Nonnull
public InviteAction setTargetApplication(long applicationId)

Description copied from interface: InviteAction

Sets the id of the targeted application.
The invite has to point to a voice channel. The invite will have the Invite.TargetType.EMBEDDED_APPLICATION target.

Specified by:

setTargetApplication in interface InviteAction

Parameters:

applicationId - The id of the embedded application to target or 0 to remove

Returns:

The current InviteAction for chaining.

setTargetStream

@Nonnull
public InviteAction setTargetStream(long userId)

Description copied from interface: InviteAction

Sets the user whose stream to target for this invite.
The user must be streaming in the same channel. The invite will have the Invite.TargetType.STREAM target.

Specified by:

setTargetStream in interface InviteAction

Parameters:

userId - The id of the user whose stream to target or 0 to remove.

Returns:

The current InviteAction for chaining.