TextChannelImpl (JDA 1.2.2

java.lang.Object
- net.dv8tion.jda.entities.TextChannel
- - net.dv8tion.jda.entities.impl.TextChannelImpl

All Implemented Interfaces:: Channel, MessageChannel

public class TextChannelImpl
extends TextChannel

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class TextChannelImpl.AsyncMessageSender

Nested Classes
Modifier and Type	Class and Description
`static class`	`TextChannelImpl.AsyncMessageSender`

Constructor Summary

Constructors
Constructor and Description

TextChannelImpl(java.lang.String id, Guild guild)

Constructors
Constructor and Description
`TextChannelImpl(java.lang.String id, Guild guild)`

Method Summary

All Methods Instance Methods Concrete Methods
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.
`int`	`hashCode()`
`Message`	`sendFile(java.io.File file)` Uploads a file to the Discord servers and sends it to this `TextChannel`.
`void`	`sendFileAsync(java.io.File file, java.util.function.Consumer<Message> callback)` Asynchronously uploads a file to the Discord servers and sends it to this `TextChannel`.
`Message`	`sendMessage(Message msg)` Sends a given `Message` to this Channel This method only extracts the mentions, text and tts status out of the given Message-Object Therefore this can also be used to resend already received Messages To allow above behaviour, this method returns a new `Message` instance.
`Message`	`sendMessage(java.lang.String text)` Sents a plain text `Message` to this channel.
`void`	`sendMessageAsync(Message msg, java.util.function.Consumer<Message> callback)` Sends a given `Message` to this Channel This method only extracts the mentions, text and tts status out of the given Message-Object Therefore this can also be used to resend already received Messages.
`void`	`sendMessageAsync(java.lang.String text, java.util.function.Consumer<Message> callback)` Sents a plain text `Message` to this channel.
`void`	`sendTyping()` Sends the typing status to discord.
`TextChannelImpl`	`setName(java.lang.String name)`
`TextChannelImpl`	`setPosition(int position)`
`TextChannelImpl`	`setTopic(java.lang.String topic)`
`java.lang.String`	`toString()`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - TextChannelImpl
```
public TextChannelImpl(java.lang.String id,
                       Guild guild)
```
- Method Detail
  - getJDA
```
public JDA getJDA()
```
    Description copied from interface: Channel
    
    Returns the JDA instance of this 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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    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.
    
    Returns:
    
    The name of this Channel
  - 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.
    
    Returns:
    
    Possibly-null String containing the topic of this Channel.
  - getGuild
```
public Guild getGuild()
```
    Description copied from interface: Channel
    
    Returns the Guild that this Channel is part of.
    
    Returns:
    
    Never-null Guild that this Channel is part of.
  - 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.
    
    Returns:
    
    A List of Users that are in this Channel.
  - 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
    
    Returns:
    
    Zero-based int of position of the Channel.
  - sendMessage
```
public Message sendMessage(java.lang.String text)
```
    Description copied from interface: MessageChannel
    
    Sents a plain text Message to this channel. This will fail if the account of the api does not have the Write-Permission for this channel set After the Message has been sent, the created Message object is returned This Object will be null, if the sending failed. When the Rate-limit is reached (30 Messages in 30 secs), a RateLimitedException is thrown
    
    Parameters:
    
    text - the text to send
    
    Returns:
    
    the Message created by this function
  - sendMessage
```
public Message sendMessage(Message msg)
```
    Description copied from interface: MessageChannel
    
    Sends a given Message to this Channel This method only extracts the mentions, text and tts status out of the given Message-Object Therefore this can also be used to resend already received Messages To allow above behaviour, this method returns a new Message instance. The passed one is not modified! If the sending of the Message failed (probably Permissions), this method returns null. When the Rate-limit is reached (30 Messages in 30 secs), a RateLimitedException is thrown
    
    Parameters:
    
    msg - the Message to send
    
    Returns:
    
    The created Message object or null if it failed
  - sendMessageAsync
```
public void sendMessageAsync(java.lang.String text,
                             java.util.function.Consumer<Message> callback)
```
    Description copied from interface: MessageChannel
    
    Sents a plain text Message to this channel. After the message has been sent, the corresponding Message object is passed to the callback-function This method will wait, and send later, if a Rate-Limit occurs.
    
    Parameters:
    
    text - the text to send
    
    callback - the Callback-function that is called upon successful sending
  - sendMessageAsync
```
public void sendMessageAsync(Message msg,
                             java.util.function.Consumer<Message> callback)
```
    Description copied from interface: MessageChannel
    
    Sends a given Message to this Channel This method only extracts the mentions, text and tts status out of the given Message-Object Therefore this can also be used to resend already received Messages. To allow above behaviour, this method calls the callback with a new Message instance. The passed one is not modified! This method will wait, and send later, if a Rate-Limit occurs.
    
    Parameters:
    
    msg - the Message to send
    
    callback - the Callback-function that is called upon successful sending
  - sendFile
```
public Message sendFile(java.io.File file)
```
    Description copied from interface: MessageChannel
    
    Uploads a file to the Discord servers and sends it to this TextChannel.
    Note: This method is blocking, which can cause problems when uploading large files.
    Consider sendFileAsync(File, Consumer) for an alternative.
    
    Parameters:
    
    file - The file to upload to the TextChannel.
    
    Returns:
    
    The Message created from this upload.
  - sendFileAsync
```
public void sendFileAsync(java.io.File file,
                          java.util.function.Consumer<Message> callback)
```
    Description copied from interface: MessageChannel
    
    Asynchronously uploads a file to the Discord servers and sends it to this TextChannel.
    
    Parameters:
    
    file - The file to upload to the TextChannel.
    
    callback - Function to deal with the returned Message after asynchronous uploading completes.
  - sendTyping
```
public void sendTyping()
```
    Description copied from interface: MessageChannel
    
    Sends the typing status to discord. This is what is used to make the message "X is typing..." appear.
    The typing status only lasts for 5 seconds, so if you wish to show continuous typing you will need to call this method once every 5 seconds.
  - 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
    
    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.
    
    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
    
    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
    
    Parameters:
    
    role - the Role to create an Override for
    
    Returns:
    
    the PermissionOverrideManager for the created PermissionOverride
  - setName
```
public TextChannelImpl setName(java.lang.String name)
```
  - setTopic
```
public TextChannelImpl setTopic(java.lang.String topic)
```
  - setPosition
```
public TextChannelImpl setPosition(int position)
```
  - getUserPermissionOverridesMap
```
public java.util.Map<User,PermissionOverride> getUserPermissionOverridesMap()
```
  - getRolePermissionOverridesMap
```
public java.util.Map<Role,PermissionOverride> getRolePermissionOverridesMap()
```
  - 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

Class TextChannelImpl

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

TextChannelImpl

Method Detail

getJDA

getOverrideForUser

getOverrideForRole

getPermissionOverrides

getUserPermissionOverrides

getRolePermissionOverrides

getId

getName

getTopic

getGuild

getUsers

getPosition

sendMessage

sendMessage

sendMessageAsync

sendMessageAsync

sendFile

sendFileAsync

sendTyping

checkPermission

getManager

createPermissionOverride

createPermissionOverride

setName

setTopic

setPosition

getUserPermissionOverridesMap

getRolePermissionOverridesMap

equals

hashCode

toString