net.dv8tion.jda.entities

Interface MessageChannel

All Known Subinterfaces:

PrivateChannel

All Known Implementing Classes:

PrivateChannelImpl, TextChannel, TextChannelImpl

public interface MessageChannel

Represents a Discord channel that can have messages and files sent to it.

Method Summary

Modifier and Type	Method and Description
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 msg, java.util.function.Consumer<Message> callback) Sents a plain text Message to this channel.
void	sendTyping() Sends the typing status to discord.

Method Detail

sendMessage

Message sendMessage(java.lang.String text)

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

Throws:

RateLimitedException - when rate-imit is reached

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 (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

Throws:

RateLimitedException - when rate-imit is reached

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

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

sendFile

Message sendFile(java.io.File file)

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

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.

Parameters:

file - The file to upload to the TextChannel.

callback - Function to deal with the returned Message after asynchronous uploading completes.

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 5 seconds, so if you wish to show continuous typing you will need to call this method once every 5 seconds.