net.dv8tion.jda.managers

Class GuildManager

java.lang.Object

net.dv8tion.jda.managers.GuildManager

public class GuildManager
extends java.lang.Object

Manager used to modify aspects of a Guild.

Constructor Summary

Constructors

Constructor and Description
GuildManager(Guild guild) Creates a GuildManager that can be used to manage different aspects of the provided Guild.

Method Summary

Modifier and Type	Method and Description
GuildManager	addRoleToUser(User user, Role... roles) Gives the User the specified Role. If the User already has the provided Role this method will do nothing.
void	ban(java.lang.String userId, int delDays) Bans the User specified by the userId nd 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.
void	ban(User user, int delDays) 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.
java.util.List<User>	getBans() Gets an unmodifiable list of the currently banned Users. If you wish to ban or unban a user, please use one of the ban or unban methods of this Manager
Guild	getGuild() Returns the Guild object of this Manager.
void	kick(java.lang.String userId) Kicks the User specified by the userId from the from the Guild.
void	kick(User user) Kicks a User from the Guild.
void	leaveOrDelete() Leaves or Deletes this Guild.
void	moveVoiceUser(User user, VoiceChannel voiceChannel) Used to move a User from one VoiceChannel to another VoiceChannel. As a note, you cannot move a User that isn't already in a VoiceChannel.
GuildManager	removeRoleFromUser(User user, Role... roles) Removes the specified Role from the User. If the User does not have the specified Role this method will do nothing.
GuildManager	setAfkChannel(VoiceChannel channel) Changes the AFK VoiceChannel of this Guild If passed null, this will disable the AFK-Channel.
GuildManager	setAfkTimeout(net.dv8tion.jda.managers.GuildManager.Timeout timeout) Changes the AFK Timeout of this Guild After given timeout (in seconds) Users being AFK in voice are being moved to the AFK-Channel Valid timeouts are: 60, 300, 900, 1800, 3600.
GuildManager	setIcon(AvatarUtil.Avatar avatar) Changes the icon of this Guild. You can create the icon via the AvatarUtil class.
GuildManager	setName(java.lang.String name) Changes the name of this Guild.
GuildManager	setRegion(Region region) Changes the Region of this Guild.
void	transferOwnership(User newOwner) Transfers the ownership of this Guild to another user.
void	unBan(java.lang.String userId) Unbans the User from the Guild based on the provided userId.
void	unBan(User user) Unbans the provided User from the Guild.
void	update() This method will apply all accumulated changes received by setters

Methods inherited from class java.lang.Object

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

Constructor Detail

GuildManager

public GuildManager(Guild guild)

Creates a GuildManager that can be used to manage different aspects of the provided Guild.

Parameters:

guild - The Guild which the manager deals with.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

Method Detail

getGuild

public Guild getGuild()

Returns the Guild object of this Manager. Useful if this Manager was returned via a create function

Returns:

the Guild of this Manager

setName

public GuildManager setName(java.lang.String name)

Changes the name of this Guild. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

name - the new name of the Guild, or null to keep current one

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

setRegion

public GuildManager setRegion(Region region)

Changes the Region of this Guild. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

region - the new Region, or null to keep current one

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

setIcon

public GuildManager setIcon(AvatarUtil.Avatar avatar)

Changes the icon of this Guild.
You can create the icon via the AvatarUtil class. Passing in null will keep the current icon, while DELETE_AVATAR removes the current one. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

avatar - the new icon, null to keep current, or AvatarUtil.DELETE_AVATAR to delete

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

setAfkChannel

public GuildManager setAfkChannel(VoiceChannel channel)

Changes the AFK VoiceChannel of this Guild If passed null, this will disable the AFK-Channel. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

channel - the new afk-channel

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

setAfkTimeout

public GuildManager setAfkTimeout(net.dv8tion.jda.managers.GuildManager.Timeout timeout)

Changes the AFK Timeout of this Guild After given timeout (in seconds) Users being AFK in voice are being moved to the AFK-Channel Valid timeouts are: 60, 300, 900, 1800, 3600. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

timeout - the new afk timeout, or null to keep current one

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

addRoleToUser

public GuildManager addRoleToUser(User user,
                                  Role... roles)

Gives the User the specified Role.
If the User already has the provided Role this method will do nothing. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

user - The User that is gaining a new Role.

roles - The Roles that are being assigned to the User.

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

removeRoleFromUser

public GuildManager removeRoleFromUser(User user,
                                       Role... roles)

Removes the specified Role from the User.
If the User does not have the specified Role this method will do nothing. This change will only be applied, if update() is called. So multiple changes can be made at once. NOTE: you cannot remove the Guild public role from a User. Attempting to do so will result in nothing happening.

Parameters:

user - The User that is having a Role removed.

roles - The Roles that are being removed from the User.

Returns:

This GuildManager instance. Useful for chaining.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

update

public void update()

This method will apply all accumulated changes received by setters

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

moveVoiceUser

public void moveVoiceUser(User user,
                          VoiceChannel voiceChannel)

Used to move a User from one VoiceChannel to another VoiceChannel.
As a note, you cannot move a User 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.

Parameters:

user - The User that you are moving.

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

Throws:

java.lang.IllegalStateException - If the User isn't currently in a VoiceChannel in this Guild.

java.lang.IllegalArgumentException -

• If the provided User is null.
• If the provided VoiceChannel is null.
• If the provided VoiceChannel isn't part of this Guild

PermissionException -

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

kick

public void kick(User user)

Kicks a User from the Guild. This change will be applied immediately.

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

Parameters:

user - The User to kick from the from the Guild.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

kick

public void kick(java.lang.String userId)

Kicks the User specified by the userId from the from the Guild. This change will be applied immediately.

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

Parameters:

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

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

ban

public void ban(User user,
                int delDays)

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.getUsers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Parameters:

user - The User to ban.

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

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

ban

public void ban(java.lang.String userId,
                int delDays)

Bans the User specified by the userId nd 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.getUsers() will still contain the User until Discord sends the GuildMemberLeaveEvent.

Parameters:

userId - The id of the User to ban.

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

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

getBans

public java.util.List<User> getBans()

Gets an unmodifiable list of the currently banned Users.
If you wish to ban or unban a user, please use one of the ban or unban methods of this Manager

Returns:

unmodifiable list of currently banned Users

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

unBan

public void unBan(User user)

Unbans the provided User from the Guild. This change will be applied immediately.

Parameters:

user - The User to unban.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

unBan

public void unBan(java.lang.String userId)

Unbans the User from the Guild based on the provided userId. This change will be applied immediately.

Parameters:

userId - The id of the User to unban.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

transferOwnership

public void transferOwnership(User newOwner)

Transfers the ownership of this Guild to another user. This will only work, if the current owner of the Guild is the JDA-user. This change will be applied immediately.

Parameters:

newOwner - the desired new Owner

Throws:

GuildUnavailableException - if the guild is temporarily unavailable

leaveOrDelete

public void leaveOrDelete()

Leaves or Deletes this Guild. If the logged in User is the owner of this Guild, the Guild is deleted. Otherwise, this guild will be left. This change will be applied immediately.

Throws:

GuildUnavailableException - if the guild is temporarily unavailable