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

Class MemberActionImpl

java.lang.Object

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

net.dv8tion.jda.internal.requests.restaction.MemberActionImpl

All Implemented Interfaces:

RestAction<Void>, MemberAction

public class MemberActionImpl
extends RestActionImpl<Void>
implements MemberAction

Field Summary

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

LOG

Constructor Summary

Constructors

Constructor	Description
MemberActionImpl(JDA api, Guild guild, String userId, String accessToken)

Method Summary

Modifier and Type	Method	Description
MemberAction	deadline(long timestamp)	Similar to RestAction.timeout(long, TimeUnit) but schedules a deadline at which the request has to be completed.
String	getAccessToken()	The access token
Guild	getGuild()	The Guild to which the user will be added.
User	getUser()	The user associated with the id
String	getUserId()	The id of the user who will be added by this task
MemberAction	setCheck(BooleanSupplier checks)	Sets the last-second checks before finally executing the http request in the queue.
MemberActionImpl	setDeafen(boolean deaf)	Whether the user should be voice deafened in the guild.
MemberActionImpl	setMute(boolean mute)	Whether the user should be voice muted in the guild.
MemberActionImpl	setNickname(String nick)	Sets the nickname of the user for the guild.
MemberActionImpl	setRoles(Collection<Role> roles)	Sets the roles of the user for the guild.
MemberActionImpl	setRoles(Role... roles)	Sets the roles of the user for the guild.
MemberAction	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

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

MemberActionImpl

public MemberActionImpl(JDA api,
 Guild guild,
 String userId,
 String accessToken)

Method Details

setCheck

@Nonnull
public MemberAction 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 MemberAction

Specified by:

setCheck in interface RestAction<Void>

Overrides:

setCheck in class RestActionImpl<Void>

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 MemberAction timeout(long timeout,
 @Nonnull
 TimeUnit unit)

Description copied from interface: RestAction

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 MemberAction

Specified by:

timeout in interface RestAction<Void>

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 MemberAction 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 MemberAction

Specified by:

deadline in interface RestAction<Void>

Overrides:

deadline in class RestActionImpl<Void>

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)

getAccessToken

@Nonnull
public String getAccessToken()

Description copied from interface: MemberAction

The access token

Specified by:

getAccessToken in interface MemberAction

Returns:

The access token

getUserId

@Nonnull
public String getUserId()

Description copied from interface: MemberAction

The id of the user who will be added by this task

Specified by:

getUserId in interface MemberAction

Returns:

The id of the user

getUser

@Nullable
public User getUser()

Description copied from interface: MemberAction

The user associated with the id

Specified by:

getUser in interface MemberAction

Returns:

Possibly-null user associated with the id

getGuild

@Nonnull
public Guild getGuild()

Description copied from interface: MemberAction

The Guild to which the user will be added.

Specified by:

getGuild in interface MemberAction

Returns:

The Guild

setNickname

@Nonnull
@CheckReturnValue
public MemberActionImpl setNickname(String nick)

Description copied from interface: MemberAction

Sets the nickname of the user for the guild.
This will then be visible with Member.getNickname().

Specified by:

setNickname in interface MemberAction

Parameters:

nick - The nickname, or null

Returns:

The current MemberAction for chaining

setRoles

@Nonnull
@CheckReturnValue
public MemberActionImpl setRoles(Collection<Role> roles)

Description copied from interface: MemberAction

Sets the roles of the user for the guild.
This will then be visible with Member.getRoles().

Specified by:

setRoles in interface MemberAction

Parameters:

roles - The roles, or null

Returns:

The current MemberAction for chaining

setRoles

@Nonnull
@CheckReturnValue
public MemberActionImpl setRoles(Role... roles)

Description copied from interface: MemberAction

Sets the roles of the user for the guild.
This will then be visible with Member.getRoles().

Specified by:

setRoles in interface MemberAction

Parameters:

roles - The roles, or null

Returns:

The current MemberAction for chaining

setMute

@Nonnull
@CheckReturnValue
public MemberActionImpl setMute(boolean mute)

Description copied from interface: MemberAction

Whether the user should be voice muted in the guild.
Default: false

Specified by:

setMute in interface MemberAction

Parameters:

mute - Whether the user should be voice muted in the guild.

Returns:

The current MemberAction for chaining

setDeafen

@Nonnull
@CheckReturnValue
public MemberActionImpl setDeafen(boolean deaf)

Description copied from interface: MemberAction

Whether the user should be voice deafened in the guild.
Default: false

Specified by:

setDeafen in interface MemberAction

Parameters:

deaf - Whether the user should be voice deafened in the guild.

Returns:

The current MemberAction for chaining