Package net.dv8tion.jda.core.managers

Class GuildController

java.lang.Object

net.dv8tion.jda.core.managers.GuildController

public class GuildController
extends java.lang.Object

A controller that allows to utilize moderation permissions and create new channels and roles.

Since:

3.0

Constructor Summary

Constructors

Constructor	Description
GuildController(Guild guild)	Creates a new GuildController instance for the specified Guild instance

Method Summary

Modifier and Type	Method	Description
AuditableRestAction<java.lang.Void>	addRolesToMember(Member member, java.util.Collection<Role> roles)	Adds all provided Roles to the specified Member
AuditableRestAction<java.lang.Void>	addRolesToMember(Member member, Role... roles)	Adds all provided Roles to the specified Member
AuditableRestAction<java.lang.Void>	addSingleRoleToMember(Member member, Role role)	Atomically assigns the provided Role to the specified Member.
AuditableRestAction<java.lang.Void>	ban(java.lang.String userId, int delDays)	Bans the a user specified by the userId and deletes messages sent by the user based on the amount of delDays.
AuditableRestAction<java.lang.Void>	ban(java.lang.String userId, int delDays, java.lang.String reason)	Bans the a user specified by the userId and deletes messages sent by the user based on the amount of delDays.
AuditableRestAction<java.lang.Void>	ban(Member member, int delDays)	Bans a Member and deletes messages sent by the user based on the amount of delDays.
AuditableRestAction<java.lang.Void>	ban(Member member, int delDays, java.lang.String reason)	Bans a Member and deletes messages sent by the user based on the amount of delDays.
AuditableRestAction<java.lang.Void>	ban(User user, int delDays)	Bans a Member and deletes messages sent by the user based on the amount of delDays.
AuditableRestAction<java.lang.Void>	ban(User user, int delDays, java.lang.String reason)	Bans a User and deletes messages sent by the user based on the amount of delDays.
ChannelAction	createCategory(java.lang.String name)	Creates a new Category in this Guild.
ChannelAction	createCopyOfChannel(Channel channel)	Creates a copy of the specified Channel in this Guild.
RoleAction	createCopyOfRole(Role role)	Creates a new Role in this Guild with the same settings as the given Role.
AuditableRestAction<Emote>	createEmote(java.lang.String name, Icon icon, Role... roles)	Creates a new Emote in this Guild.
RoleAction	createRole()	Creates a new Role in this Guild.
ChannelAction	createTextChannel(java.lang.String name)	Creates a new TextChannel in this Guild.
ChannelAction	createVoiceChannel(java.lang.String name)	Creates a new VoiceChannel in this Guild.
Guild	getGuild()	The underlying Guild instance
JDA	getJDA()	The JDA instance of this GuildController
AuditableRestAction<java.lang.Void>	kick(java.lang.String userId)	Kicks the Member specified by the userId from the from the Guild.
AuditableRestAction<java.lang.Void>	kick(java.lang.String userId, java.lang.String reason)	Kicks the Member specified by the userId from the from the Guild.
AuditableRestAction<java.lang.Void>	kick(Member member)	Kicks a Member from the Guild.
AuditableRestAction<java.lang.Void>	kick(Member member, java.lang.String reason)	Kicks a Member from the Guild.
ChannelOrderAction<Category>	modifyCategoryPositions()	Modifies the positional order of Guild.getCategories() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
AuditableRestAction<java.lang.Void>	modifyMemberRoles(Member member, java.util.Collection<Role> roles)	Modifies the complete Role set of the specified Member The provided roles will replace all current Roles of the specified Member.
AuditableRestAction<java.lang.Void>	modifyMemberRoles(Member member, java.util.Collection<Role> rolesToAdd, java.util.Collection<Role> rolesToRemove)	Modifies the Roles of the specified Member by adding and removing a collection of roles.
AuditableRestAction<java.lang.Void>	modifyMemberRoles(Member member, Role... roles)	Modifies the complete Role set of the specified Member The provided roles will replace all current Roles of the specified Member.
RoleOrderAction	modifyRolePositions()	Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.
RoleOrderAction	modifyRolePositions(boolean useDiscordOrder)	Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.
ChannelOrderAction<TextChannel>	modifyTextChannelPositions()	Modifies the positional order of Guild.getTextChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
CategoryOrderAction<TextChannel>	modifyTextChannelPositions(Category category)	Modifies the positional order of Category#getTextChannels() using an extension of ChannelOrderAction specialized for ordering the nested TextChannels of this Category.
ChannelOrderAction<VoiceChannel>	modifyVoiceChannelPositions()	Modifies the positional order of Guild.getVoiceChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
CategoryOrderAction<VoiceChannel>	modifyVoiceChannelPositions(Category category)	Modifies the positional order of Category#getVoiceChannels() using an extension of ChannelOrderAction specialized for ordering the nested VoiceChannels of this Category.
RestAction<java.lang.Void>	moveVoiceMember(Member member, VoiceChannel voiceChannel)	Used to move a Member from one VoiceChannel to another VoiceChannel.
AuditableRestAction<java.lang.Integer>	prune(int days)	This method will prune (kick) all members who were offline for at least days days.
AuditableRestAction<java.lang.Void>	removeRolesFromMember(Member member, java.util.Collection<Role> roles)	Removes all provided Roles from the specified Member
AuditableRestAction<java.lang.Void>	removeRolesFromMember(Member member, Role... roles)	Removes all provided Roles from the specified Member
AuditableRestAction<java.lang.Void>	removeSingleRoleFromMember(Member member, Role role)	Atomically removes the provided Role from the specified Member.
AuditableRestAction<java.lang.Void>	setDeafen(Member member, boolean deafen)	Sets the Guild Deafened state state of the Member based on the provided boolean.
AuditableRestAction<java.lang.Void>	setMute(Member member, boolean mute)	Sets the Guild Muted state state of the Member based on the provided boolean.
AuditableRestAction<java.lang.Void>	setNickname(Member member, java.lang.String nickname)	Changes a Member's nickname in this guild.
AuditableRestAction<java.lang.Void>	transferOwnership(Member newOwner)	Transfers the Guild ownership to the specified Member Only available if the currently logged in account is the owner of this Guild
AuditableRestAction<java.lang.Void>	unban(java.lang.String userId)	Unbans the a user specified by the userId from this Guild.
AuditableRestAction<java.lang.Void>	unban(User user)	Unbans the specified User from this Guild.

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildController

public GuildController(Guild guild)

Creates a new GuildController instance for the specified Guild instance

Parameters:

guild - The Guild that will be modified

Method Detail

getGuild

public Guild getGuild()

The underlying Guild instance

Returns:

The underlying Guild instance

getJDA

public JDA getJDA()

The JDA instance of this GuildController

Returns:

the corresponding JDA instance

moveVoiceMember

@CheckReturnValue
public RestAction<java.lang.Void> moveVoiceMember(Member member,
                                                  VoiceChannel voiceChannel)

Used to move a Member from one VoiceChannel to another VoiceChannel.
As a note, you cannot move a Member that isn't already in a VoiceChannel. Also they must be in a VoiceChannel in the same Guild as the one that you are moving them to.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be moved due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task
• UNKNOWN_CHANNEL
  The specified channel was deleted before finishing the task

Parameters:

member - The Member that you are moving.

voiceChannel - The destination VoiceChannel to which the member is being moved to.

Returns:

RestAction

Throws:

java.lang.IllegalStateException - If the Member isn't currently in a VoiceChannel in this Guild, or CacheFlag.VOICE_STATE is disabled.

java.lang.IllegalArgumentException -

• If any of the provided arguments is null
• If the provided Member isn't part of this Guild
• If the provided VoiceChannel isn't part of this Guild

InsufficientPermissionException -

• If this account doesn't have Permission.VOICE_MOVE_OTHERS in the VoiceChannel that the Member is currently in.
• If this account AND the Member being moved don't have Permission.VOICE_CONNECT for the destination VoiceChannel.

setNickname

@CheckReturnValue
public AuditableRestAction<java.lang.Void> setNickname(Member member,
                                                       java.lang.String nickname)

Changes a Member's nickname in this guild. The nickname is visible to all members of this guild.

To change the nickname for the currently logged in account only the Permission NICKNAME_CHANGE is required.
To change the nickname of any Member for this Guild the Permission NICKNAME_MANAGE is required.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The nickname of the target Member is not modifiable due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member for which the nickname should be changed.

nickname - The new nickname of the Member, provide null or an empty String to reset the nickname

Returns:

AuditableRestAction

Throws:

java.lang.IllegalArgumentException - If the specified Member is not from the same Guild. Or if the provided member is null

InsufficientPermissionException -

• If attempting to set nickname for self and the logged in account has neither Permission.NICKNAME_CHANGE or Permission.NICKNAME_MANAGE
• If attempting to set nickname for another member and the logged in account does not have Permission.NICKNAME_MANAGE

HierarchyException - If attempting to set nickname for another member and the logged in account cannot manipulate the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

prune

@CheckReturnValue
public AuditableRestAction<java.lang.Integer> prune(int days)

This method will prune (kick) all members who were offline for at least days days.
The RestAction returned from this method will return the amount of Members that were pruned.
You can use Guild.getPrunableMemberCount(int) to determine how many Members would be pruned if you were to call this method.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The prune cannot finished due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

days - Minimum number of days since a member has been offline to get affected.

Returns:

AuditableRestAction - Type: Integer
The amount of Members that were pruned from the Guild.

Throws:

InsufficientPermissionException - If the account doesn't have KICK_MEMBER Permission.

java.lang.IllegalArgumentException - If the provided days are less than 1

kick

@CheckReturnValue
public AuditableRestAction<java.lang.Void> kick(Member member,
                                                java.lang.String reason)

Kicks a Member from the Guild.

Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member to kick from the from the Guild.

reason - The reason for this action or null if there is no specified reason

Returns:

AuditableRestAction Kicks the provided Member from the current Guild

Throws:

java.lang.IllegalArgumentException - If the provided member is not a Member of this Guild or is null

InsufficientPermissionException - If the logged in account does not have the Permission.KICK_MEMBERS permission.

HierarchyException - If the logged in account cannot kick the other member due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

kick

@CheckReturnValue
public AuditableRestAction<java.lang.Void> kick(java.lang.String userId,
                                                java.lang.String reason)

Kicks the Member specified by the userId from the from the Guild.

Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

userId - The id of the User to kick from the from the Guild.

reason - The reason for this action or null if there is no specified reason

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.KICK_MEMBERS permission.

HierarchyException - If the logged in account cannot kick the other member due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException - If the userId provided does not correspond to a Member in this Guild or the provided userId is blank/null.

kick

@CheckReturnValue
public AuditableRestAction<java.lang.Void> kick(Member member)

Kicks a Member from the Guild.

Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member to kick from the from the Guild.

Returns:

AuditableRestAction Kicks the provided Member from the current Guild

Throws:

java.lang.IllegalArgumentException - If the provided member is not a Member of this Guild or is null

InsufficientPermissionException - If the logged in account does not have the Permission.KICK_MEMBERS permission.

HierarchyException - If the logged in account cannot kick the other member due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

kick

@CheckReturnValue
public AuditableRestAction<java.lang.Void> kick(java.lang.String userId)

Kicks the Member specified by the userId from the from the Guild.

Note: Guild.getMembers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be kicked due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

userId - The id of the User to kick from the from the Guild.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.KICK_MEMBERS permission.

HierarchyException - If the logged in account cannot kick the other member due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException - If the userId provided does not correspond to a Member in this Guild or the provided userId is blank/null.

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(Member member,
                                               int delDays,
                                               java.lang.String reason)

Bans a Member and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a member without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the Member until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member to ban.

delDays - The history of messages, in days, that will be deleted.

reason - The reason for this action or null if there is no specified reason

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided member is null

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(User user,
                                               int delDays,
                                               java.lang.String reason)

Bans a User and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a user without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the User's Member object (if the User was in the Guild) until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

user - The User to ban.

delDays - The history of messages, in days, that will be deleted.

reason - The reason for this action or null if there is no specified reason

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided user is null

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(java.lang.String userId,
                                               int delDays,
                                               java.lang.String reason)

Bans the a user specified by the userId and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a user without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the User's Member object (if the User was in the Guild) until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

userId - The id of the User to ban.

delDays - The history of messages, in days, that will be deleted.

reason - The reason for this action or null if there is no specified reason

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided userId is null

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(Member member,
                                               int delDays)

Bans a Member and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a member without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the Member until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member to ban.

delDays - The history of messages, in days, that will be deleted.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided member is null

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(User user,
                                               int delDays)

Bans a Member and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a member without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the Member until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

user - The User to ban.

delDays - The history of messages, in days, that will be deleted.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided user is null

ban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> ban(java.lang.String userId,
                                               int delDays)

Bans the a user specified by the userId and deletes messages sent by the user based on the amount of delDays.
If you wish to ban a user without deleting any messages, provide delDays with a value of 0. This change will be applied immediately.

Note: Guild.getMembers() will still contain the User's Member object (if the User was in the Guild) until Discord sends the GuildMemberLeaveEvent.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be banned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

userId - The id of the User to ban.

delDays - The history of messages, in days, that will be deleted.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

HierarchyException - If the logged in account cannot ban the other user due to permission hierarchy position.
See PermissionUtil.canInteract(Member, Member)

java.lang.IllegalArgumentException -

• If the provided amount of days (delDays) is less than 0.
• If the provided amount of days (delDays) is bigger than 7.
• If the provided userId is null

unban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> unban(User user)

Unbans the specified User from this Guild.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be unbanned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_USER
  The specified User is invalid

Parameters:

user - The id of the User to unban.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

java.lang.IllegalArgumentException - If the provided user is null

unban

@CheckReturnValue
public AuditableRestAction<java.lang.Void> unban(java.lang.String userId)

Unbans the a user specified by the userId from this Guild.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be unbanned due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_USER
  The specified User is invalid

Parameters:

userId - The id of the User to unban.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.BAN_MEMBERS permission.

java.lang.IllegalArgumentException - If the provided id is null or blank

setDeafen

@CheckReturnValue
public AuditableRestAction<java.lang.Void> setDeafen(Member member,
                                                     boolean deafen)

Sets the Guild Deafened state state of the Member based on the provided boolean.

Note: The Member's GuildVoiceState.isGuildDeafened() value won't change until JDA receives the GuildVoiceGuildDeafenEvent event related to this change.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be deafened due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member who's VoiceState is being changed.

deafen - Whether this Member should be deafened or undeafened.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.VOICE_DEAF_OTHERS permission.

HierarchyException - If the provided member is the Guild's owner. You cannot modify the owner of a Guild.

java.lang.IllegalArgumentException - If the provided member is not from this Guild or null.

setMute

@CheckReturnValue
public AuditableRestAction<java.lang.Void> setMute(Member member,
                                                   boolean mute)

Sets the Guild Muted state state of the Member based on the provided boolean.

Note: The Member's GuildVoiceState.isGuildMuted() value won't change until JDA receives the GuildVoiceGuildMuteEvent event related to this change.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The target Member cannot be muted due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The specified Member was removed from the Guild before finishing the task

Parameters:

member - The Member who's VoiceState is being changed.

mute - Whether this Member should be muted or unmuted.

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.VOICE_DEAF_OTHERS permission.

HierarchyException - If the provided member is the Guild's owner. You cannot modify the owner of a Guild.

java.lang.IllegalArgumentException - If the provided member is not from this Guild or null.

addSingleRoleToMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> addSingleRoleToMember(Member member,
                                                                 Role role)

Atomically assigns the provided Role to the specified Member.
This can be used together with other role modification methods as it does not require an updated cache!

If multiple roles should be added/removed (efficiently) in one request you may use modifyMemberRoles(Member, Collection, Collection) or similar methods.

If the specified role is already present in the member's set of roles this does nothing.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task
• UNKNOWN_ROLE
  If the specified Role does not exist

Parameters:

member - The target member who will receive the new role

role - The role which should be assigned atomically

Returns:

AuditableRestAction

Throws:

java.lang.IllegalArgumentException -

• If the specified member/role are not from the current Guild
• Either member or role are null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

removeSingleRoleFromMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> removeSingleRoleFromMember(Member member,
                                                                      Role role)

Atomically removes the provided Role from the specified Member.
This can be used together with other role modification methods as it does not require an updated cache!

If multiple roles should be added/removed (efficiently) in one request you may use modifyMemberRoles(Member, Collection, Collection) or similar methods.

If the specified role is not present in the member's set of roles this does nothing.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task
• UNKNOWN_ROLE
  If the specified Role does not exist

Parameters:

member - The target member who will lose the specified role

role - The role which should be removed atomically

Returns:

AuditableRestAction

Throws:

java.lang.IllegalArgumentException -

• If the specified member/role are not from the current Guild
• Either member or role are null

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

addRolesToMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> addRolesToMember(Member member,
                                                            Role... roles)

Adds all provided Roles to the specified Member

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GuildMemberRoleAddEvent.
To add and remove Roles from a Member you should use modifyMemberRoles(Member, Collection, Collection)

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - Not-null Member that will receive all provided roles

roles - Not-null Roles that should be added to the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any or the provided entities is null
• If any of the provided entities is not in this Guild
• If any of the provided Roles is the Public Role of the Guild
• If any of the provided Roles are managed
  Managed Roles can only be applied by the applications that manage them (e.g. Twitch Subscriber Roles)

See Also:

addRolesToMember(Member, Collection), modifyMemberRoles(Member, Role...)

addRolesToMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> addRolesToMember(Member member,
                                                            java.util.Collection<Role> roles)

Adds all provided Roles to the specified Member

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GuildMemberRoleAddEvent.
To add and remove Roles from a Member you should use modifyMemberRoles(Member, Collection, Collection)

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - Not-null Member that will receive all provided roles

roles - Not-null Roles that should be added to the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any or the provided entities is null
• If any of the provided entities is not in this Guild
• If any of the provided Roles is the Public Role of the Guild
• If any of the provided Roles are managed
  Managed Roles can only be applied by the applications that manage them (e.g. Twitch Subscriber Roles)

See Also:

addRolesToMember(Member, Role...), modifyMemberRoles(Member, Collection)

removeRolesFromMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> removeRolesFromMember(Member member,
                                                                 Role... roles)

Removes all provided Roles from the specified Member

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GuildMemberRoleRemoveEvent.
To add and remove Roles from a Member you should use modifyMemberRoles(Member, Collection, Collection)

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - Not-null Member from which to remove the Roles

roles - Not-null Roles that should be removed from the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any or the provided entities is null
• If any of the provided entities is not in this Guild
• If any of the provided Roles is the Public Role of the Guild
• If any of the provided Roles are managed
  Managed Roles can only be applied by the applications that manage them (e.g. Twitch Subscriber Roles)

See Also:

addRolesToMember(Member, Collection), modifyMemberRoles(Member, Role...)

removeRolesFromMember

@CheckReturnValue
public AuditableRestAction<java.lang.Void> removeRolesFromMember(Member member,
                                                                 java.util.Collection<Role> roles)

Removes all provided Roles from the specified Member

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GuildMemberRoleRemoveEvent.
To add and remove Roles from a Member you should use modifyMemberRoles(Member, Collection, Collection)

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - Not-null Member from which to remove the Roles

roles - Not-null Roles that should be removed from the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any or the provided entities is null
• If any of the provided entities is not in this Guild
• If any of the provided Roles is the Public Role of the Guild
• If any of the provided Roles are managed
  Managed Roles can only be applied by the applications that manage them (e.g. Twitch Subscriber Roles)

See Also:

addRolesToMember(Member, Role...), modifyMemberRoles(Member, Collection)

modifyMemberRoles

@CheckReturnValue
public AuditableRestAction<java.lang.Void> modifyMemberRoles(Member member,
                                                             java.util.Collection<Role> rolesToAdd,
                                                             java.util.Collection<Role> rolesToRemove)

Modifies the Roles of the specified Member by adding and removing a collection of roles.
None of the provided roles may be the Public Role of the current Guild.
If a role is both in rolesToAdd and rolesToRemove it will be removed.

None of the provided collections may be null
To only add or remove roles use either removeRolesFromMember(Member, Collection) or addRolesToMember(Member, Collection)

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GenericGuildMemberEvent targeting the same Member.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - The Member that should be modified

rolesToAdd - A Collection of Roles to add to the current Roles the specified Member already has

rolesToRemove - A Collection of Roles to remove from the current Roles the specified Member already has

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any of the provided arguments is null
• If any of the specified Roles is managed or is the Public Role of the Guild

modifyMemberRoles

@CheckReturnValue
public AuditableRestAction<java.lang.Void> modifyMemberRoles(Member member,
                                                             Role... roles)

Modifies the complete Role set of the specified Member
The provided roles will replace all current Roles of the specified Member.

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GenericGuildMemberEvent targeting the same Member.

The new roles must not contain the Public Role of the Guild

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - A Member of which to override the Roles of

roles - New collection of Roles for the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any of the provided arguments is null
• If any of the provided arguments is not from this Guild
• If any of the specified Roles is managed
• If any of the specified Roles is the Public Role of this Guild

See Also:

modifyMemberRoles(Member, Collection)

modifyMemberRoles

@CheckReturnValue
public AuditableRestAction<java.lang.Void> modifyMemberRoles(Member member,
                                                             java.util.Collection<Role> roles)

Modifies the complete Role set of the specified Member
The provided roles will replace all current Roles of the specified Member.

The new roles must not contain the Public Role of the Guild

Warning

This may not be used together with any other role add/remove/modify methods for the same Member within one event listener cycle! The changes made by this require cache updates which are triggered by lifecycle events which are received later. This may only be called again once the specific Member has been updated by a GenericGuildMemberEvent targeting the same Member.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The Members Roles could not be modified due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

member - A Member of which to override the Roles of

roles - New collection of Roles for the specified Member

Returns:

AuditableRestAction

Throws:

InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_ROLES

HierarchyException - If the provided roles are higher in the Guild's hierarchy and thus cannot be modified by the currently logged in account

java.lang.IllegalArgumentException -

• If any of the provided arguments is null
• If any of the provided arguments is not from this Guild
• If any of the specified Roles is managed
• If any of the specified Roles is the Public Role of this Guild

See Also:

modifyMemberRoles(Member, Collection)

transferOwnership

@CheckReturnValue
public AuditableRestAction<java.lang.Void> transferOwnership(Member newOwner)

Transfers the Guild ownership to the specified Member
Only available if the currently logged in account is the owner of this Guild

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The currently logged in account lost ownership before completing the task
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• UNKNOWN_MEMBER
  The target Member was removed from the Guild before finishing the task

Parameters:

newOwner - Not-null Member to transfer ownership to

Returns:

AuditableRestAction

Throws:

PermissionException - If the currently logged in account is not the owner of this Guild

java.lang.IllegalArgumentException -

• If the specified Member is null or not from the same Guild
• If the specified Member already is the Guild owner
• If the specified Member is a bot account (AccountType.BOT)

createTextChannel

@CheckReturnValue
public ChannelAction createTextChannel(java.lang.String name)

Creates a new TextChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

name - The name of the TextChannel to create

Returns:

A specific ChannelAction
This action allows to set fields for the new TextChannel before creating it

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.MANAGE_CHANNEL permission

java.lang.IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

createVoiceChannel

@CheckReturnValue
public ChannelAction createVoiceChannel(java.lang.String name)

Creates a new VoiceChannel in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

name - The name of the VoiceChannel to create

Returns:

A specific ChannelAction
This action allows to set fields for the new VoiceChannel before creating it

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.MANAGE_CHANNEL permission

java.lang.IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

createCategory

@CheckReturnValue
public ChannelAction createCategory(java.lang.String name)

Creates a new Category in this Guild. For this to be successful, the logged in account has to have the MANAGE_CHANNEL Permission.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

name - The name of the Category to create

Returns:

A specific ChannelAction
This action allows to set fields for the new Category before creating it

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.MANAGE_CHANNEL permission

java.lang.IllegalArgumentException - If the provided name is null or empty or greater than 100 characters in length

createCopyOfChannel

@CheckReturnValue
public ChannelAction createCopyOfChannel(Channel channel)

Creates a copy of the specified Channel in this Guild.
The provided channel need not be in the same Guild for this to work!

This copies the following elements:

1. Name
2. Parent Category (if present)
3. Voice Elements (Bitrate, Userlimit)
4. Text Elements (Topic, NSFW)
5. All permission overrides for Members/Roles

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The channel could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

channel - The Channel to use for the copy template

Returns:

A specific ChannelAction
This action allows to set fields for the new Channel before creating it!

Throws:

java.lang.IllegalArgumentException - If the provided channel is null

InsufficientPermissionException - If the currently logged in account does not have the MANAGE_CHANNEL Permission

Since:

3.1

See Also:

createTextChannel(String), createVoiceChannel(String), ChannelAction

createRole

@CheckReturnValue
public RoleAction createRole()

Creates a new Role in this Guild.
It will be placed at the bottom (just over the Public Role) to avoid permission hierarchy conflicts.
For this to be successful, the logged in account has to have the MANAGE_ROLES Permission

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The role could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• MAX_ROLES_PER_GUILD
  There are too many roles in this Guild

Returns:

RoleAction
Creates a new role with previously selected field values

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.MANAGE_ROLES Permission

createCopyOfRole

@CheckReturnValue
public RoleAction createCopyOfRole(Role role)

Creates a new Role in this Guild with the same settings as the given Role.
The position of the specified Role does not matter in this case!

It will be placed at the bottom (just over the Public Role) to avoid permission hierarchy conflicts.
For this to be successful, the logged in account has to have the MANAGE_ROLES Permission and all Permissions the given Role has.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The role could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task
• MAX_ROLES_PER_GUILD
  There are too many roles in this Guild

Parameters:

role - The Role that should be copied

Returns:

RoleAction
RoleAction with already copied values from the specified Role

Throws:

InsufficientPermissionException - If the logged in account does not have the Permission.MANAGE_ROLES Permission and every Permission the provided Role has

java.lang.IllegalArgumentException - If the specified role is null

createEmote

@CheckReturnValue
public AuditableRestAction<Emote> createEmote(java.lang.String name,
                                              Icon icon,
                                              Role... roles)

Creates a new Emote in this Guild.
If one or more Roles are specified the new Emote will only be available to Members with any of the specified Roles (see Member.canInteract(Emote))
For this to be successful, the logged in account has to have the MANAGE_EMOTES Permission.

Unicode emojis are not included as Emote!

Note that a guild is limited to 50 normal and 50 animated emotes by default. Some guilds are able to add additional emotes beyond this limitation due to the MORE_EMOJI feature (see Guild.getFeatures()).
Due to simplicity we do not check for these limits.

Possible ErrorResponses caused by the returned RestAction include the following:

• MISSING_PERMISSIONS
  The emote could not be created due to a permission discrepancy
• MISSING_ACCESS
  We were removed from the Guild before finishing the task

Parameters:

name - The name for the new Emote

icon - The Icon for the new Emote

roles - The Roles the new Emote should be restricted to
If no roles are provided the Emote will be available to all Members of this Guild

Returns:

AuditableRestAction - Type: Emote

Throws:

InsufficientPermissionException - If the logged in account does not have the MANAGE_EMOTES Permission

modifyCategoryPositions

@CheckReturnValue
public ChannelOrderAction<Category> modifyCategoryPositions()

Modifies the positional order of Guild.getCategories() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Returns:

ChannelOrderAction - Type: Category

modifyTextChannelPositions

@CheckReturnValue
public ChannelOrderAction<TextChannel> modifyTextChannelPositions()

Modifies the positional order of Guild.getTextChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Returns:

ChannelOrderAction - Type: TextChannel

modifyVoiceChannelPositions

@CheckReturnValue
public ChannelOrderAction<VoiceChannel> modifyVoiceChannelPositions()

Modifies the positional order of Guild.getVoiceChannels() using a specific RestAction extension to allow moving Channels up/down or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Returns:

ChannelOrderAction - Type: VoiceChannel

modifyTextChannelPositions

@CheckReturnValue
public CategoryOrderAction<TextChannel> modifyTextChannelPositions(Category category)

Modifies the positional order of Category#getTextChannels() using an extension of ChannelOrderAction specialized for ordering the nested TextChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move TextChannels up, down, or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task.
• MISSING_ACCESS
  The currently logged in account was removed from the Guild.

Parameters:

category - The Category to order TextChannels from.

Returns:

CategoryOrderAction - Type: TextChannel

modifyVoiceChannelPositions

@CheckReturnValue
public CategoryOrderAction<VoiceChannel> modifyVoiceChannelPositions(Category category)

Modifies the positional order of Category#getVoiceChannels() using an extension of ChannelOrderAction specialized for ordering the nested VoiceChannels of this Category.
Like ChannelOrderAction, the returned CategoryOrderAction can be used to move VoiceChannels up, down, or to a specific position.
This uses ascending order with a 0 based index.

Possible ErrorResponses include:

• UNNKOWN_CHANNEL
  One of the channels has been deleted before the completion of the task.
• MISSING_ACCESS
  The currently logged in account was removed from the Guild.

Parameters:

category - The Category to order VoiceChannels from.

Returns:

CategoryOrderAction - Type: VoiceChannels

modifyRolePositions

@CheckReturnValue
public RoleOrderAction modifyRolePositions()

Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.

This uses the ordering defined by Discord, which is descending!
This means the highest role appears at index 0 and the lower role at index n - 1.
Providing false to modifyRolePositions(boolean) will result in the ordering being in ascending order, with the lower role at index 0 and the highest at index n - 1.
As a note: Member.getRoles() and Guild.getRoles() are both in descending order.

Possible ErrorResponses include:

• UNKNOWN_ROLE
  One of the roles was deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Returns:

RoleOrderAction

modifyRolePositions

@CheckReturnValue
public RoleOrderAction modifyRolePositions(boolean useDiscordOrder)

Modifies the positional order of Guild.getRoles() using a specific RestAction extension to allow moving Roles up/down or to a specific position.

Possible ErrorResponses include:

• UNKNOWN_ROLE
  One of the roles was deleted before the completion of the task
• MISSING_ACCESS
  The currently logged in account was removed from the Guild

Parameters:

useDiscordOrder - Defines the ordering of the OrderAction. If true, the OrderAction will be in the ordering defined by Discord for roles, which is Descending. This means that the highest role appears at index 0 and the lowest role at index n - 1. Providing false will result in the ordering being in ascending order, with the lower role at index 0 and the highest at index n - 1.
As a note: Member.getRoles() and Guild.getRoles() are both in descending order.

Returns:

RoleOrderAction