net.dv8tion.jda.entities

Interface Channel

All Known Subinterfaces:

VoiceChannel

All Known Implementing Classes:

TextChannel, TextChannelImpl, VoiceChannelImpl

public interface Channel

Represents a Guild channel.

Method Summary

Modifier and Type	Method and Description
boolean	checkPermission(User user, Permission permission) 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.
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.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.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.

Method Detail

getId

java.lang.String getId()

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

Returns:

The Id of this Channel

getName

java.lang.String getName()

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

Returns:

The name of this Channel

getTopic

java.lang.String getTopic()

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

Returns:

Possibly-null String containing the topic of this Channel.

getGuild

Guild getGuild()

Returns the Guild that this Channel is part of.

Returns:

Never-null Guild that this Channel is part of.

getUsers

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. In VoiceChannels, this returns all Users that joined that VoiceChannel.

Returns:

A List of Users that are in this Channel.

getPosition

int getPosition()

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

Returns:

Zero-based int of position of the Channel.

checkPermission

boolean checkPermission(User user,
                        Permission permission)

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

Parameters:

user - the User to check the Permission against

permission - the Permission to check for

Returns:

if the given User has the given Permission in this Channel

getManager

ChannelManager getManager()

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

Returns:

The ChannelManager of this Channel

getJDA

JDA getJDA()

Returns the JDA instance of this Channel

Returns:

the corresponding JDA instance

getOverrideForUser

PermissionOverride getOverrideForUser(User user)

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

Parameters:

user - The User whose PermissionOverride is requested.

Returns:

Possibly-null PermissionOverride relating to the provided User.

getOverrideForRole

PermissionOverride getOverrideForRole(Role role)

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

Parameters:

role - The Role whose PermissionOverride is requested.

Returns:

Possibly-null PermissionOverride relating to the provided Role.

getPermissionOverrides

java.util.List<PermissionOverride> getPermissionOverrides()

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 getUserPermissionOverrides() or getRolePermissionOverrides() respectively.

Returns:

Possibly-empty list of all PermissionOverrides for this Channel.

getUserPermissionOverrides

java.util.List<PermissionOverride> getUserPermissionOverrides()

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

Returns:

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

getRolePermissionOverrides

java.util.List<PermissionOverride> getRolePermissionOverrides()

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

Returns:

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

createPermissionOverride

PermissionOverrideManager createPermissionOverride(User user)

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

Parameters:

user - the User to create an Override for

Returns:

the PermissionOverrideManager for the created PermissionOverride

createPermissionOverride

PermissionOverrideManager createPermissionOverride(Role role)

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

Parameters:

role - the Role to create an Override for

Returns:

the PermissionOverrideManager for the created PermissionOverride