net.dv8tion.jda.entities.impl

Class PrivateChannelImpl

java.lang.Object

net.dv8tion.jda.entities.impl.PrivateChannelImpl

All Implemented Interfaces:

MessageChannel, PrivateChannel

public class PrivateChannelImpl
extends java.lang.Object
implements PrivateChannel

Constructor Summary

Constructors

Constructor and Description
PrivateChannelImpl(java.lang.String id, User user, JDAImpl api)

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.String	getId() The Id of the PrivateChannel.
JDA	getJDA() Returns the JDA instance of this PrivateChannel
User	getUser() The User that this PrivateChannel communicates with.
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.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PrivateChannelImpl

public PrivateChannelImpl(java.lang.String id,
                          User user,
                          JDAImpl api)

Method Detail

getJDA

public JDA getJDA()

Description copied from interface: PrivateChannel

Returns the JDA instance of this PrivateChannel

Specified by:

getJDA in interface PrivateChannel

Returns:

the corresponding JDA instance

getId

public java.lang.String getId()

Description copied from interface: PrivateChannel

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

Specified by:

getId in interface PrivateChannel

Returns:

String containing Id.

getUser

public User getUser()

Description copied from interface: PrivateChannel

The User that this PrivateChannel communicates with.

Specified by:

getUser in interface PrivateChannel

Returns:

A non-null User.

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

Specified by:

sendMessage in interface MessageChannel

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

Specified by:

sendMessage in interface MessageChannel

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.

Specified by:

sendMessageAsync in interface MessageChannel

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.

Specified by:

sendMessageAsync in interface MessageChannel

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.

Specified by:

sendFile in interface MessageChannel

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.

Specified by:

sendFileAsync in interface MessageChannel

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.

Specified by:

sendTyping in interface MessageChannel

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