Package net.dv8tion.jda.core.requests.restaction

Class InviteAction

java.lang.Object

net.dv8tion.jda.core.requests.RestAction<T>

net.dv8tion.jda.core.requests.restaction.AuditableRestAction<Invite>

net.dv8tion.jda.core.requests.restaction.InviteAction

public class InviteAction
extends AuditableRestAction<Invite>

Invite Builder system created as an extension of RestAction
Provides an easy way to gather and deliver information to Discord to create Invites.

Nested Class Summary

Nested classes/interfaces inherited from class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

AuditableRestAction.EmptyRestAction<T>

Field Summary

Fields inherited from class net.dv8tion.jda.core.requests.RestAction

DEFAULT_FAILURE, DEFAULT_SUCCESS, LOG

Constructor Summary

Constructors

Constructor	Description
InviteAction(JDA api, java.lang.String channelId)

Method Summary

Modifier and Type	Method	Description
InviteAction	setCheck(java.util.function.BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
InviteAction	setMaxAge(java.lang.Integer maxAge)	Sets the max age in seconds for the invite.
InviteAction	setMaxAge(java.lang.Long maxAge, java.util.concurrent.TimeUnit timeUnit)	Sets the max age for the invite.
InviteAction	setMaxUses(java.lang.Integer maxUses)	Sets the max uses for the invite.
InviteAction	setTemporary(java.lang.Boolean temporary)	Sets whether the invite should only grant temporary membership.
InviteAction	setUnique(java.lang.Boolean unique)	Sets whether discord should reuse a similar invite.

Methods inherited from class net.dv8tion.jda.core.requests.restaction.AuditableRestAction

reason

Methods inherited from class java.lang.Object

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

Methods inherited from class net.dv8tion.jda.core.requests.RestAction

complete, complete, completeAfter, getJDA, isPassContext, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, setPassContext, submit, submit, submitAfter, submitAfter

Constructor Detail

InviteAction

public InviteAction(JDA api,
                    java.lang.String channelId)

Method Detail

setCheck

public InviteAction setCheck(java.util.function.BooleanSupplier checks)

Description copied from class: 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.

Overrides:

setCheck in class AuditableRestAction<Invite>

Parameters:

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

Returns:

The current RestAction for chaining convenience

setMaxAge

@CheckReturnValue
public final InviteAction setMaxAge(java.lang.Integer maxAge)

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.

Parameters:

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

Returns:

The current InviteAction for chaining.

Throws:

java.lang.IllegalArgumentException - If maxAge is negative.

setMaxAge

@CheckReturnValue
public final InviteAction setMaxAge(java.lang.Long maxAge,
                                    java.util.concurrent.TimeUnit timeUnit)

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.

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.

Throws:

java.lang.IllegalArgumentException - If maxAge is negative or maxAge is positive and timeUnit is null.

setMaxUses

@CheckReturnValue
public final InviteAction setMaxUses(java.lang.Integer maxUses)

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.

Parameters:

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

Returns:

The current InviteAction for chaining.

Throws:

java.lang.IllegalArgumentException - If maxUses is negative.

setTemporary

@CheckReturnValue
public final InviteAction setTemporary(java.lang.Boolean temporary)

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

Parameters:

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

Returns:

The current InviteAction for chaining.

setUnique

@CheckReturnValue
public final InviteAction setUnique(java.lang.Boolean unique)

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

Parameters:

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

Returns:

The current InviteAction for chaining.