net.dv8tion.jda.entities.impl

Class VoiceChannelImpl

java.lang.Object

net.dv8tion.jda.entities.impl.VoiceChannelImpl

All Implemented Interfaces:

Channel, VoiceChannel

public class VoiceChannelImpl
extends java.lang.Object
implements VoiceChannel

Constructor Summary

Constructors

Constructor and Description
VoiceChannelImpl(java.lang.String id, Guild guild)

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(User user, Permission perm) Checks if the given User has the given Permission in this Channel
PermissionOverrideManager	createPermissionOverride(Role role) Creates a new PermissionOverride for a given Role.
PermissionOverrideManager	createPermissionOverride(User user) Creates a new PermissionOverride for a given User.
boolean	equals(java.lang.Object o)
Guild	getGuild() Returns the Guild that this Channel is part of.
java.lang.String	getId() The Id of the Channel.
JDA	getJDA() Returns the JDA instance of this Channel
ChannelManager	getManager() Returns the ChannelManager for this Channel.
java.lang.String	getName() The human readable name of the Channel. If no name has been set, this returns null.
PermissionOverride	getOverrideForRole(Role role) The PermissionOverride relating to the specified Role.
PermissionOverride	getOverrideForUser(User user) The PermissionOverride relating to the specified User.
java.util.List<PermissionOverride>	getPermissionOverrides() Gets all of the PermissionOverrides that are part of this Channel. This combines User and Role overrides.
int	getPosition() The position this Channel is displayed at. Higher values mean they are displayed lower in the Client.
java.util.List<PermissionOverride>	getRolePermissionOverrides() Gets all of the Role PermissionOverrides that are part of this Channel.
java.util.Map<Role,PermissionOverride>	getRolePermissionOverridesMap()
java.lang.String	getTopic() The topic set for this Channel.
java.util.List<PermissionOverride>	getUserPermissionOverrides() Gets all of the User PermissionOverrides that are part of this Channel.
java.util.Map<User,PermissionOverride>	getUserPermissionOverridesMap()
java.util.List<User>	getUsers() A List of all Users that are in this Channel For TextChannels, this returns all Users with the Permission.MESSAGE_READ Permission.
java.util.List<User>	getUsersModifiable()
int	hashCode()
VoiceChannelImpl	setName(java.lang.String name)
VoiceChannelImpl	setPosition(int position)
VoiceChannelImpl	setUsers(java.util.List<User> connectedUsers)
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

VoiceChannelImpl

public VoiceChannelImpl(java.lang.String id,
                        Guild guild)

Method Detail

getJDA

public JDA getJDA()

Description copied from interface: Channel

Returns the JDA instance of this Channel

Specified by:

getJDA in interface Channel

Returns:

the corresponding JDA instance

getOverrideForUser

public PermissionOverride getOverrideForUser(User user)

Description copied from interface: Channel

The PermissionOverride relating to the specified User. If there is no PermissionOverride for this Channel relating to the provided User, then this returns null.

Specified by:

getOverrideForUser in interface Channel

Parameters:

user - The User whose PermissionOverride is requested.

Returns:

Possibly-null PermissionOverride relating to the provided User.

getOverrideForRole

public PermissionOverride getOverrideForRole(Role role)

Description copied from interface: Channel

The PermissionOverride relating to the specified Role. If there is no PermissionOverride for this Channel relating to the provided Role, then this returns null.

Specified by:

getOverrideForRole in interface Channel

Parameters:

role - The Role whose PermissionOverride is requested.

Returns:

Possibly-null PermissionOverride relating to the provided Role.

getPermissionOverrides

public java.util.List<PermissionOverride> getPermissionOverrides()

Description copied from interface: Channel

Gets all of the PermissionOverrides that are part of this Channel.
This combines User and Role overrides. If you would like only User overrides or only Role overrides, use Channel.getUserPermissionOverrides() or Channel.getRolePermissionOverrides() respectively.

Specified by:

getPermissionOverrides in interface Channel

Returns:

Possibly-empty list of all PermissionOverrides for this Channel.

getUserPermissionOverrides

public java.util.List<PermissionOverride> getUserPermissionOverrides()

Description copied from interface: Channel

Gets all of the User PermissionOverrides that are part of this Channel.

Specified by:

getUserPermissionOverrides in interface Channel

Returns:

Possibly-empty list of all PermissionOverrides for Users for this Channel.

getRolePermissionOverrides

public java.util.List<PermissionOverride> getRolePermissionOverrides()

Description copied from interface: Channel

Gets all of the Role PermissionOverrides that are part of this Channel.

Specified by:

getRolePermissionOverrides in interface Channel

Returns:

Possibly-empty list of all PermissionOverrides for Roles for this Channel.

getId

public java.lang.String getId()

Description copied from interface: Channel

The Id of the Channel. This is typically 18 characters long.

Specified by:

getId in interface Channel

Returns:

The Id of this Channel

getName

public java.lang.String getName()

Description copied from interface: Channel

The human readable name of the Channel.
If no name has been set, this returns null.

Specified by:

getName in interface Channel

Returns:

The name of this Channel

getGuild

public Guild getGuild()

Description copied from interface: Channel

Returns the Guild that this Channel is part of.

Specified by:

getGuild in interface Channel

Returns:

Never-null Guild that this Channel is part of.

getPosition

public int getPosition()

Description copied from interface: Channel

The position this Channel is displayed at.
Higher values mean they are displayed lower in the Client. Position 0 is the top most Channel Channels of a Guild do not have to have continuous positions

Specified by:

getPosition in interface Channel

Returns:

Zero-based int of position of the Channel.

getUsers

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

Description copied from interface: Channel

A List of all Users that are in this Channel For TextChannels, this returns all Users with the Permission.MESSAGE_READ Permission. In VoiceChannels, this returns all Users that joined that VoiceChannel.

Specified by:

getUsers in interface Channel

Returns:

A List of Users that are in this Channel.

checkPermission

public boolean checkPermission(User user,
                               Permission perm)

Description copied from interface: Channel

Checks if the given User has the given Permission in this Channel

Specified by:

checkPermission in interface Channel

Parameters:

user - the User to check the Permission against

perm - the Permission to check for

Returns:

if the given User has the given Permission in this Channel

getManager

public ChannelManager getManager()

Description copied from interface: Channel

Returns the ChannelManager for this Channel. In the ChannelManager, you can modify the name, topic and position of this Channel.

Specified by:

getManager in interface Channel

Returns:

The ChannelManager of this Channel

createPermissionOverride

public PermissionOverrideManager createPermissionOverride(User user)

Description copied from interface: Channel

Creates a new PermissionOverride for a given User. For this to be successful, the logged in account has to have the MANAGE_PERMISSIONS Permission

Specified by:

createPermissionOverride in interface Channel

Parameters:

user - the User to create an Override for

Returns:

the PermissionOverrideManager for the created PermissionOverride

createPermissionOverride

public PermissionOverrideManager createPermissionOverride(Role role)

Description copied from interface: Channel

Creates a new PermissionOverride for a given Role. For this to be successful, the logged in account has to have the MANAGE_PERMISSIONS Permission

Specified by:

createPermissionOverride in interface Channel

Parameters:

role - the Role to create an Override for

Returns:

the PermissionOverrideManager for the created PermissionOverride

setName

public VoiceChannelImpl setName(java.lang.String name)

setPosition

public VoiceChannelImpl setPosition(int position)

setUsers

public VoiceChannelImpl setUsers(java.util.List<User> connectedUsers)

getUsersModifiable

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

getUserPermissionOverridesMap

public java.util.Map<User,PermissionOverride> getUserPermissionOverridesMap()

getRolePermissionOverridesMap

public java.util.Map<Role,PermissionOverride> getRolePermissionOverridesMap()

getTopic

public java.lang.String getTopic()

Description copied from interface: Channel

The topic set for this Channel. If no topic has been set, this returns null.

Specified by:

getTopic in interface Channel

Returns:

Possibly-null String containing the topic of this Channel.

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object