Package net.dv8tion.jda.api.entities

Interface PrivateChannel

All Superinterfaces:

AbstractChannel, java.util.Formattable, ISnowflake, MessageChannel

public interface PrivateChannel
extends MessageChannel

Represents the connection used for direct messaging.

See Also:

User.openPrivateChannel()

Method Summary

Modifier and Type	Method	Description
RestAction<java.lang.Void>	close()	Closes a PrivateChannel.
User	getUser()	The User that this PrivateChannel communicates with.

Methods inherited from interface net.dv8tion.jda.api.entities.AbstractChannel

getJDA, getName, getType

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

getId, getIdLong, getTimeCreated

Methods inherited from interface net.dv8tion.jda.api.entities.MessageChannel

addReactionById, addReactionById, addReactionById, addReactionById, deleteMessageById, deleteMessageById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, formatTo, getHistory, getHistoryAfter, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, getLatestMessageId, getLatestMessageIdLong, hasLatestMessage, pinMessageById, pinMessageById, purgeMessages, purgeMessages, purgeMessagesById, purgeMessagesById, purgeMessagesById, removeReactionById, removeReactionById, removeReactionById, removeReactionById, retrieveMessageById, retrieveMessageById, retrievePinnedMessages, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFile, sendFile, sendFile, sendFile, sendMessage, sendMessage, sendMessage, sendMessageEmbeds, sendMessageEmbeds, sendMessageFormat, sendTyping, unpinMessageById, unpinMessageById

Method Detail

getUser

@Nonnull
User getUser()

The User that this PrivateChannel communicates with.

Returns:

A non-null User.

close

@Nonnull
@CheckReturnValue
RestAction<java.lang.Void> close()

Closes a PrivateChannel. After being closed successfully the PrivateChannel is removed from the JDA mapping.
As a note, this does not remove the history of the PrivateChannel. If the channel is reopened the history will still be present.

Returns:

RestAction - Type: Void