Channel (JDA 3.8.1

All Superinterfaces:

ISnowflake

All Known Subinterfaces:

Category, TextChannel, VoiceChannel
```
public interface Channel
extends ISnowflake
```
Represents a Guild channel.

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method	Description
`default ChannelAction`	`createCopy()`	Creates a copy of the specified `Channel`.
`ChannelAction`	`createCopy(Guild guild)`	Creates a copy of the specified `Channel` in the specified `Guild`.
`InviteAction`	`createInvite()`	Creates a new `InviteAction` which can be used to create a new `Invite`.
`PermissionOverrideAction`	`createPermissionOverride(Member member)`	Creates a `PermissionOverride` for the specified `Member` in this Channel.
`PermissionOverrideAction`	`createPermissionOverride(Role role)`	Creates a `PermissionOverride` for the specified `Role` in this Channel.
`AuditableRestAction<java.lang.Void>`	`delete()`	Deletes this Channel.
`Guild`	`getGuild()`	Returns the `Guild` that this Channel is part of.
`RestAction<java.util.List<Invite>>`	`getInvites()`	Returns all invites for this channel.
`JDA`	`getJDA()`	Returns the `JDA` instance of this Channel
`ChannelManager`	`getManager()`	Returns the `ChannelManager` for this Channel.
`java.util.List<PermissionOverride>`	`getMemberPermissionOverrides()`	Gets all of the `Member` `PermissionOverrides` that are part of this `Channel`.
`java.util.List<Member>`	`getMembers()`	A List of all `Members` that are in this Channel For `TextChannels`, this returns all Members with the `Permission.MESSAGE_READ` Permission.
`java.lang.String`	`getName()`	The human readable name of the Channel.
`Category`	`getParent()`	Parent `Category` of this Channel.
`PermissionOverride`	`getPermissionOverride(Member member)`	The `PermissionOverride` relating to the specified `Member`.
`PermissionOverride`	`getPermissionOverride(Role role)`	The `PermissionOverride` relating to the specified `Role`.
`java.util.List<PermissionOverride>`	`getPermissionOverrides()`	Gets all of the `PermissionOverrides` that are part of this `Channel`.
`int`	`getPosition()`	The position this Channel is displayed at.
`int`	`getPositionRaw()`	The actual position of the `Channel` as stored and given by Discord.
`java.util.List<PermissionOverride>`	`getRolePermissionOverrides()`	Gets all of the `Role` `PermissionOverrides` that are part of this `Channel`.
`ChannelType`	`getType()`	The `ChannelType` for this Channel
`PermissionOverrideAction`	`putPermissionOverride(Member member)`	Creates a `PermissionOverride` for the specified `Member` in this Channel.
`PermissionOverrideAction`	`putPermissionOverride(Role role)`	Creates a `PermissionOverride` for the specified `Role` in this Channel.

Methods inherited from interface net.dv8tion.jda.core.entities.ISnowflake
getCreationTime, getId, getIdLong

- Method Detail
  - getType
```
ChannelType getType()
```
    The ChannelType for this Channel
    
    Returns:
    
    The channel type
  - 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
  - getGuild
```
Guild getGuild()
```
    Returns the Guild that this Channel is part of.
    
    Returns:
    
    Never-null Guild that this Channel is part of.
  - getParent
```
Category getParent()
```
    Parent Category of this Channel. Channels need not have a parent Category.
    Note that an Category will always return null for this method as nested categories are not supported.
    
    Returns:
    
    Possibly-null Category for this Channel
  - getMembers
```
java.util.List<Member> getMembers()
```
    A List of all Members that are in this Channel For TextChannels, this returns all Members with the Permission.MESSAGE_READ Permission. In VoiceChannels, this returns all Members that joined that VoiceChannel.
    
    Returns:
    
    A List of Members 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.
  - getPositionRaw
```
int getPositionRaw()
```
    The actual position of the Channel as stored and given by Discord. Role positions are actually based on a pairing of the creation time (as stored in the snowflake id) and the position. If 2 or more roles share the same position then they are sorted based on their creation date. The more recent a role was created, the lower it is in the hierarchy. This is handled by getPosition() and it is most likely the method you want. If, for some reason, you want the actual position of the Role then this method will give you that value.
    
    Returns:
    
    The true, Discord stored, position of the Channel.
  - getJDA
```
JDA getJDA()
```
    Returns the JDA instance of this Channel
    
    Returns:
    
    the corresponding JDA instance
  - getPermissionOverride
```
PermissionOverride getPermissionOverride(Member member)
```
    The PermissionOverride relating to the specified Member. If there is no PermissionOverride for this Channel relating to the provided Member, then this returns null.
    
    Parameters:
    
    member - The Member whose PermissionOverride is requested.
    
    Returns:
    
    Possibly-null PermissionOverride relating to the provided Member.
  - getPermissionOverride
```
PermissionOverride getPermissionOverride(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 Member and Role overrides. If you would like only Member overrides or only Role overrides, use getMemberPermissionOverrides() or getRolePermissionOverrides() respectively.
    
    Returns:
    
    Possibly-empty list of all PermissionOverrides for this Channel.
  - getMemberPermissionOverrides
```
java.util.List<PermissionOverride> getMemberPermissionOverrides()
```
    Gets all of the Member PermissionOverrides that are part of this Channel.
    
    Returns:
    
    Possibly-empty list of all PermissionOverrides for Member 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.
  - createCopy
```
@CheckReturnValue
ChannelAction createCopy(Guild guild)
```
    Creates a copy of the specified Channel in the specified Guild.
    If the provided target guild is not the same Guild this channel is in then the parent category and permissions will not be copied due to technical difficulty and ambiguity.
    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:
    
    guild - The Guild to create the channel in
    
    Returns:
    
    A specific ChannelAction
    This action allows to set fields for the new Channel before creating it!
    
    Throws:
    
    java.lang.IllegalArgumentException - If the provided guild is null
    
    PermissionException - If the currently logged in account does not have the MANAGE_CHANNEL Permission
  - createCopy
```
@CheckReturnValue
default ChannelAction createCopy()
```
    Creates a copy of the specified Channel.
    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
    Returns:
    
    A specific ChannelAction
    This action allows to set fields for the new Channel before creating it!
    
    Throws:
    
    PermissionException - If the currently logged in account does not have the MANAGE_CHANNEL Permission
  - getManager
```
ChannelManager getManager()
```
    Returns the ChannelManager for this Channel.
    In the ChannelManager, you can modify the name, topic and position of this Channel. You modify multiple fields in one request by chaining setters before calling RestAction.queue().
    
    Returns:
    
    The ChannelManager of this Channel
    
    Throws:
    
    InsufficientPermissionException - If the currently logged in account does not have Permission.MANAGE_CHANNEL
  - delete
```
@CheckReturnValue
AuditableRestAction<java.lang.Void> delete()
```
    Deletes this Channel.
    Possible ErrorResponses include:
    - UNKNOWN_CHANNEL
      If this channel was already deleted
    - MISSING_PERMISSIONS
      The send request was attempted after the account lost Permission.MANAGE_CHANNEL in the channel.
    - MISSING_ACCESS
      If we were removed from the Guild
    Returns:
    
    AuditableRestAction
    
    Throws:
    
    InsufficientPermissionException - if the currently logged in account doesn't have MANAGE_CHANNEL for the channel.
  - createPermissionOverride
```
@CheckReturnValue
PermissionOverrideAction createPermissionOverride(Member member)
```
    Creates a PermissionOverride for the specified Member in this Channel. You can use putPermissionOverride(Member) to replace existing overrides.
    Possible ErrorResponses include:
    - UNKNOWN_CHANNEL
      If this channel was already deleted
    - MISSING_ACCESS
      If we were removed from the Guild
    Parameters:
    
    member - The Member to create an override for
    
    Returns:
    
    PermissionOverrideAction Provides the newly created PermissionOverride for the specified Role
    
    Throws:
    
    InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS
    
    java.lang.IllegalArgumentException - if the specified Member is null or the Member is not from getGuild()
    
    java.lang.IllegalStateException - If the specified Member already has a PermissionOverride. Use getPermissionOverride(Member) to retrieve it. You can use putPermissionOverride(Member) to replace existing overrides.
    
    See Also:
    
    createPermissionOverride(Role), putPermissionOverride(Member)
  - createPermissionOverride
```
@CheckReturnValue
PermissionOverrideAction createPermissionOverride(Role role)
```
    Creates a PermissionOverride for the specified Role in this Channel. You can use putPermissionOverride(Role) to replace existing overrides.
    Possible ErrorResponses include:
    - UNKNOWN_CHANNEL
      If this channel was already deleted
    - MISSING_ACCESS
      If we were removed from the Guild
    Parameters:
    
    role - The Role to create an override for
    
    Returns:
    
    PermissionOverrideAction Provides the newly created PermissionOverride for the specified Role
    
    Throws:
    
    InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS
    
    java.lang.IllegalArgumentException - if the specified Role is null or the Role is not from getGuild()
    
    java.lang.IllegalStateException - If the specified Role already has a PermissionOverride. Use getPermissionOverride(Role) to retrieve it. You can use putPermissionOverride(Role) to replace existing overrides.
    
    See Also:
    
    createPermissionOverride(Member), putPermissionOverride(Role)
  - putPermissionOverride
```
@CheckReturnValue
PermissionOverrideAction putPermissionOverride(Member member)
```
    Creates a PermissionOverride for the specified Member in this Channel.
    If the member already has an existing override it will be replaced.
    
    Parameters:
    
    member - The Member to create the override for
    
    Returns:
    
    PermissionOverrideAction Provides the newly created PermissionOverride for the specified Member
    
    Throws:
    
    InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS
    
    java.lang.IllegalArgumentException - If the provided member is null or from a different guild
    
    See Also:
    
    putPermissionOverride(Role)
  - putPermissionOverride
```
@CheckReturnValue
PermissionOverrideAction putPermissionOverride(Role role)
```
    Creates a PermissionOverride for the specified Role in this Channel.
    If the role already has an existing override it will be replaced.
    
    Parameters:
    
    role - The Role to create the override for
    
    Returns:
    
    PermissionOverrideAction Provides the newly created PermissionOverride for the specified Role
    
    Throws:
    
    InsufficientPermissionException - if we don't have the permission to MANAGE_PERMISSIONS
    
    java.lang.IllegalArgumentException - If the provided role is null or from a different guild
    
    See Also:
    
    putPermissionOverride(Member)
  - createInvite
```
@CheckReturnValue
InviteAction createInvite()
```
    Creates a new InviteAction which can be used to create a new Invite.
    Requires CREATE_INSTANT_INVITE in this channel.
    
    Returns:
    
    A new InviteAction
    
    Throws:
    
    InsufficientPermissionException - If the account does not have CREATE_INSTANT_INVITE in this channel
    
    java.lang.IllegalArgumentException - If this is an instance of a Category
    
    See Also:
    
    InviteAction
  - getInvites
```
@CheckReturnValue
RestAction<java.util.List<Invite>> getInvites()
```
    Returns all invites for this channel.
    Requires MANAGE_CHANNEL in this channel. Will throw a InsufficientPermissionException otherwise.
    
    Returns:
    
    RestAction - Type: List<Invite>
    The list of expanded Invite objects
    
    Throws:
    
    InsufficientPermissionException - if the account does not have MANAGE_CHANNEL in this channel
    
    See Also:
    
    Guild.getInvites()

Interface Channel

Method Summary

Methods inherited from interface net.dv8tion.jda.core.entities.ISnowflake

Method Detail

getType

getName

getGuild

getParent

getMembers

getPosition

getPositionRaw

getJDA

getPermissionOverride

getPermissionOverride

getPermissionOverrides

getMemberPermissionOverrides

getRolePermissionOverrides

createCopy

createCopy

getManager

delete

createPermissionOverride

createPermissionOverride

putPermissionOverride

putPermissionOverride

createInvite

getInvites