MessageChannel (JDA 2.2.1

All Known Subinterfaces:

PrivateChannel, TextChannel
```
public interface MessageChannel
```
Represents a Discord channel that can have messages and files sent to it.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`boolean`	`deleteMessageById(java.lang.String messageId)` Attempts to delete a `Message` from the Discord servers that has the same id as the id provided.
`MessageHistory`	`getHistory()` Creates a new `MessageHistory` object for each call of this method. This is NOT and internal message cache, but rather it queries the Discord servers for old messages.
`java.lang.String`	`getId()` The Id of the Channel.
`JDA`	`getJDA()` Returns the `JDA` instance of this MessageChannel
`Message`	`getMessageById(java.lang.String messageId)` Attempts to get a `Message` from the Discord servers that has the same id as the id provided.
`java.util.List<Message>`	`getPinnedMessages()` Gets a List of `Messages` that have been pinned in this channel. If no messages have been pinned, this returns an empty List.
`boolean`	`pinMessageById(java.lang.String messageId)` Used to pin a message. If the provided messageId is invalid or not in this channel, this does nothing.
`Message`	`sendFile(java.io.File file, Message message)` Uploads a file to the Discord servers and sends it to this `TextChannel`.
`void`	`sendFileAsync(java.io.File file, Message message, 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)` Sends 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 msg, java.util.function.Consumer<Message> callback)` Sents a plain text `Message` to this channel.
`void`	`sendTyping()` Sends the typing status to discord.
`boolean`	`unpinMessageById(java.lang.String messageId)` Used to unpin a message. If the provided messageId is invalid or not in this channel, this does nothing.

- Method Detail
  - getJDA
```
JDA getJDA()
```
    Returns the JDA instance of this MessageChannel
    
    Returns:
    
    the corresponding JDA instance
  - getId
```
java.lang.String getId()
```
    The Id of the Channel. This is typically 18 characters long.
    
    Returns:
    
    The Id of this Channel
  - sendMessage
```
Message sendMessage(java.lang.String text)
```
    Sends 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 (10 Messages in 10 secs), a RateLimitedException is thrown
    
    Parameters:
    
    text - the text to send
    
    Returns:
    
    the Message created by this function
    
    Throws:
    
    RateLimitedException - when rate-imit is reached
    
    PermissionException - If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    BlockedException - If this is a PrivateChannel and PMs are blocked
    
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - sendMessage
```
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. 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 (10 Messages in 10 secs), a RateLimitedException is thrown
    
    Parameters:
    
    msg - the Message to send
    
    Returns:
    
    The created Message object or null if it failed
    
    Throws:
    
    RateLimitedException - when rate-limit is reached
    
    PermissionException - If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    BlockedException - If this is a PrivateChannel and PMs are blocked
    
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - sendMessageAsync
```
void sendMessageAsync(java.lang.String msg,
                      java.util.function.Consumer<Message> callback)
```
    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:
    
    msg - the text to send
    
    callback - the Callback-function that is called upon successful sending with the Message-object of the sent message or null, if sending failed. You can pass null as callback, if you do not need the created Message-object.
    
    Throws:
    
    PermissionException - If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - sendMessageAsync
```
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. 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 with the Message-object of the sent message or null, if sending failed. You can pass null as callback, if you do not need the created Message-object.
    
    Throws:
    
    PermissionException - If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - sendFile
```
Message sendFile(java.io.File file,
                 Message message)
```
    Uploads a file to the Discord servers and sends it to this TextChannel. Sends the provided Message with the uploaded file.
    If you do not wish to send a Message with the uploaded file, you can provide null for the message parameter.
    Note: This method is blocking, which can cause problems when uploading large files.
    Consider sendFileAsync(java.io.File, net.dv8tion.jda.entities.Message, java.util.function.Consumer) for an alternative.
    Parameters:
    
    file - The file to upload to the TextChannel.
    
    message - The message to be sent along with the uploaded file. This value can be null.
    
    Returns:
    
    The Message created from this upload.
    
    Throws:
    PermissionException -
    
    If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    If this is a TextChannel and the logged in account does not have Permission.MESSAGE_ATTACH_FILES.
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - sendFileAsync
```
void sendFileAsync(java.io.File file,
                   Message message,
                   java.util.function.Consumer<Message> callback)
```
    Asynchronously uploads a file to the Discord servers and sends it to this TextChannel. Sends the provided Message with the uploaded file.
    If you do not wish to send a Message with the uploaded file, you can provide null for the message parameter.
    Parameters:
    
    file - The file to upload to the TextChannel.
    
    message - The message to be sent along with the uploaded file. This value can be null.
    
    callback - Function to deal with the returned Message after asynchronous uploading completes.
    
    Throws:
    PermissionException -
    
    If this is a TextChannel and the logged in account does not have Permission.MESSAGE_WRITE.
    
    If this is a TextChannel and the logged in account does not have Permission.MESSAGE_ATTACH_FILES.
    VerificationLevelException - If this is a TextChannel and you do not meet the required verification-level of the guild.
  - getMessageById
```
Message getMessageById(java.lang.String messageId)
```
    Attempts to get a Message from the Discord servers that has the same id as the id provided.
    Parameters:
    
    messageId - The id of the sought after Message
    
    Returns:
    
    The Message defined by the provided id. `Null` if the message doesn't exist.
    
    Throws:
    PermissionException - Thrown if:
    
    Attempt to get a message from a channel which this account doesn't have access to. (Permission.MESSAGE_READ)
    
    Attempt to get a message from a channel that this account cannot read the history of. (Permission.MESSAGE_HISTORY)
  - deleteMessageById
```
boolean deleteMessageById(java.lang.String messageId)
```
    Attempts to delete a Message from the Discord servers that has the same id as the id provided.
    Parameters:
    
    messageId - The id of the Message which should be deleted
    
    Returns:
    
    True if the message was successfully deleted. False if the message didn't exist.
    
    Throws:
    PermissionException - Thrown if:
    
    Attempt to get a message from a channel which this account doesn't have access to. (Permission.MESSAGE_READ)
    
    Attempt to delete another user's message in a channel that this account doesn't have permission to manage. (Permission.MESSAGE_MANAGE)
    
    Attempt to delete another user's message in a PrivateChannel.
  - getHistory
```
MessageHistory getHistory()
```
    Creates a new MessageHistory object for each call of this method.
    This is NOT and internal message cache, but rather it queries the Discord servers for old messages.
    
    Returns:
    
    The MessageHistory for this channel.
  - sendTyping
```
void sendTyping()
```
    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 10 seconds or until a message is sent.
    So if you wish to show continuous typing you will need to call this method once every 10 seconds.
    The official discord client sends this every 5 seconds even though the typing status lasts 10.
  - pinMessageById
```
boolean pinMessageById(java.lang.String messageId)
```
    Used to pin a message.
    If the provided messageId is invalid or not in this channel, this does nothing.
    
    Parameters:
    
    messageId - The message to pin.
    
    Returns:
    
    True - if the message was successfully unpinned. If false, the message id probably didn't exist or wasn't a message from this channel.
    
    Throws:
    
    PermissionException - If this is a TextChannel and this account does not have both Permission.MESSAGE_READ and Permission.MESSAGE_MANAGE
    
    RateLimitedException - If Discord informs us that this account has accessed this endpoint too often, thus needs to be ratelimited.
  - unpinMessageById
```
boolean unpinMessageById(java.lang.String messageId)
```
    Used to unpin a message.
    If the provided messageId is invalid or not in this channel, this does nothing.
    
    Parameters:
    
    messageId - The message to pin.
    
    Returns:
    
    True - if the message was successfully unpinned. If false, the message id probably didn't exist or wasn't a message from this channel.
    
    Throws:
    
    PermissionException - If this is a TextChannel and this account does not have both Permission.MESSAGE_READ and Permission.MESSAGE_MANAGE
    
    RateLimitedException - If Discord informs us that this account has accessed this endpoint too often, thus needs to be ratelimited.
  - getPinnedMessages
```
java.util.List<Message> getPinnedMessages()
```
    Gets a List of Messages that have been pinned in this channel.
    If no messages have been pinned, this returns an empty List.
    
    Returns:
    
    An unmodifiable List containing all pinned messages.
    
    Throws:
    
    PermissionException - If this is a TextChannel and this account does not have Permission.MESSAGE_READ
    
    RateLimitedException - If Discord informs us that this account has accessed this endpoint too often, thus needs to be ratelimited.

Interface MessageChannel

Method Summary

Method Detail

getJDA

getId

sendMessage

sendMessage

sendMessageAsync

sendMessageAsync

sendFile

sendFileAsync

getMessageById

deleteMessageById

getHistory

sendTyping

pinMessageById

unpinMessageById

getPinnedMessages