net.dv8tion.jda.managers

Class ChannelManager

java.lang.Object

net.dv8tion.jda.managers.ChannelManager

public class ChannelManager
extends java.lang.Object

Manager used to modify aspects of a TextChannel or VoiceChannel.

Constructor Summary

Constructors

Constructor and Description
ChannelManager(Channel channel)

Method Summary

Modifier and Type	Method and Description
void	delete() Deletes this Channel This method takes immediate effect
Channel	getChannel() Returns the Channel object of this Manager.
ChannelManager	setName(java.lang.String name) Sets the name of this Channel.
ChannelManager	setPosition(int newPosition) Sets the position of this Channel.
ChannelManager	setTopic(java.lang.String topic) Sets the topic of this Channel.
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

ChannelManager

public ChannelManager(Channel channel)

Method Detail

setName

public ChannelManager setName(java.lang.String name)

Sets the name of this Channel. 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 Channel, or null to keep current one

Returns:

this

getChannel

public Channel getChannel()

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

Returns:

the Channel of this Manager

setTopic

public ChannelManager setTopic(java.lang.String topic)

Sets the topic of this Channel. This is not available for VoiceChannels and will result in a UnsupportedOperationException. This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

topic - The new topic of the Channel, or null to keep current one

Returns:

this

Throws:

java.lang.UnsupportedOperationException - thrown when attempting to set the topic for a VoiceChannel

setPosition

public ChannelManager setPosition(int newPosition)

Sets the position of this Channel. If another Channel of the same Type and target newPosition already exists in this Guild, this channel will get placed above the existing one (newPosition gets decremented). This change will only be applied, if update() is called. So multiple changes can be made at once.

Parameters:

newPosition - The new position of the Channel, or -1 to keep current one

Returns:

this

delete

public void delete()

Deletes this Channel This method takes immediate effect

update

public void update()

This method will apply all accumulated changes received by setters