Interface InviteAction
-
- All Superinterfaces:
AuditableRestAction<Invite>
,RestAction<Invite>
public interface InviteAction extends AuditableRestAction<Invite>
Invite
Builder system created as an extension ofRestAction
Provides an easy way to gather and deliver information to Discord to createInvites
.- See Also:
GuildChannel.createInvite()
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description InviteAction
setCheck(BooleanSupplier checks)
Sets the last-second checks before finally executing the http request in the queue.InviteAction
setMaxAge(Integer maxAge)
Sets the max age in seconds for the invite.InviteAction
setMaxAge(Long maxAge, TimeUnit timeUnit)
Sets the max age for the invite.InviteAction
setMaxUses(Integer maxUses)
Sets the max uses for the invite.InviteAction
setTemporary(Boolean temporary)
Sets whether the invite should only grant temporary membership.InviteAction
setUnique(Boolean unique)
Sets whether discord should reuse a similar invite.-
Methods inherited from interface net.dv8tion.jda.api.requests.restaction.AuditableRestAction
reason
-
Methods inherited from interface net.dv8tion.jda.api.requests.RestAction
complete, complete, completeAfter, getJDA, queue, queue, queue, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, queueAfter, submit, submit, submitAfter, submitAfter
-
-
-
-
Method Detail
-
setCheck
@Nonnull InviteAction setCheck(@Nullable BooleanSupplier checks)
Description copied from interface:AuditableRestAction
Sets the last-second checks before finally executing the http request in the queue.
If the provided supplier evaluates tofalse
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 interfaceAuditableRestAction<Invite>
- Specified by:
setCheck
in interfaceRestAction<Invite>
- Parameters:
checks
- The checks to run before executing the request, ornull
to run no checks- Returns:
- The current RestAction for chaining convenience
-
setMaxAge
@Nonnull @CheckReturnValue InviteAction setMaxAge(@Nullable Integer maxAge)
Sets the max age in seconds for the invite. Set this to0
if the invite should never expire. Default is86400
(24 hours).null
will reset this to the default value.- Parameters:
maxAge
- The max age for this invite ornull
to use the default value.- Returns:
- The current InviteAction for chaining.
- Throws:
IllegalArgumentException
- If maxAge is negative.
-
setMaxAge
@Nonnull @CheckReturnValue InviteAction setMaxAge(@Nullable Long maxAge, @Nonnull TimeUnit timeUnit)
Sets the max age for the invite. Set this to0
if the invite should never expire. Default is86400
(24 hours).null
will reset this to the default value.- Parameters:
maxAge
- The max age for this invite ornull
to use the default value.timeUnit
- TheTimeUnit
type ofmaxAge
.- Returns:
- The current InviteAction for chaining.
- Throws:
IllegalArgumentException
- If maxAge is negative or maxAge is positive and timeUnit is null.
-
setMaxUses
@Nonnull @CheckReturnValue InviteAction setMaxUses(@Nullable Integer maxUses)
Sets the max uses for the invite. Set this to0
if the invite should have unlimited uses. Default is0
.null
will reset this to the default value.- Parameters:
maxUses
- The max uses for this invite ornull
to use the default value.- Returns:
- The current InviteAction for chaining.
- Throws:
IllegalArgumentException
- If maxUses is negative.
-
setTemporary
@Nonnull @CheckReturnValue InviteAction setTemporary(@Nullable Boolean temporary)
Sets whether the invite should only grant temporary membership. Default isfalse
.- Parameters:
temporary
- Whether the invite should only grant temporary membership ornull
to use the default value.- Returns:
- The current InviteAction for chaining.
-
setUnique
@Nonnull @CheckReturnValue InviteAction setUnique(@Nullable Boolean unique)
Sets whether discord should reuse a similar invite. Default isfalse
.- Parameters:
unique
- Whether discord should reuse a similar invite ornull
to use the default value.- Returns:
- The current InviteAction for chaining.
-
-