Package org.javacord.api.entity.channel

Interface PrivateChannel

All Superinterfaces:

Channel, ChannelAttachableListenerManager, ChannelSpecialization, DiscordEntity, Messageable, PrivateChannelAttachableListenerManager, ServerThreadChannelAttachableListenerManager, Specializable<ChannelSpecialization>, TextChannel, TextChannelAttachableListenerManager, Updatable, UpdatableFromCache, VoiceChannel, VoiceChannelAttachableListenerManager

public interface PrivateChannel
extends TextChannel, VoiceChannel, PrivateChannelAttachableListenerManager

This class represents a private channel. Every conversation between two users takes place in a private channel.

Method Summary

Modifier and Type	Method	Description
default java.util.Optional<PrivateChannel>	getCurrentCachedInstance()	Gets an updated instance of this entity from the cache.
default java.util.concurrent.CompletableFuture<PrivateChannel>	getLatestInstance()	Gets an updated instance of this entity from the cache or from Discord directly.
java.util.Optional<User>	getRecipient()	Gets the recipient of the private channel.
java.util.Optional<java.lang.Long>	getRecipientId()	Gets the id of the recipient of the private channel.
default ChannelType	getType()	Gets the type of the channel.

Methods inherited from interface org.javacord.api.entity.channel.Channel

asCategorizable, asChannelCategory, asPrivateChannel, asRegularServerChannel, asServerChannel, asServerForumChannel, asServerStageVoiceChannel, asServerTextChannel, asServerThreadChannel, asServerVoiceChannel, asTextChannel, asVoiceChannel, canSee, canYouSee

Methods inherited from interface org.javacord.api.listener.channel.ChannelAttachableListenerManager

addChannelAttachableListener, getChannelAttachableListeners, removeChannelAttachableListener, removeListener

Methods inherited from interface org.javacord.api.entity.DiscordEntity

getApi, getCreationTimestamp, getId, getIdAsString

Methods inherited from interface org.javacord.api.entity.message.Messageable

sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage, sendMessage

Methods inherited from interface org.javacord.api.listener.channel.user.PrivateChannelAttachableListenerManager

addPrivateChannelAttachableListener, addPrivateChannelDeleteListener, getPrivateChannelAttachableListeners, getPrivateChannelDeleteListeners, removeListener, removePrivateChannelAttachableListener

Methods inherited from interface org.javacord.api.listener.channel.ServerThreadChannelAttachableListenerManager

addServerThreadChannelAttachableListener, addServerThreadChannelCreateListener, addServerThreadChannelDeleteListener, addServerThreadChannelMembersUpdateListener, addServerThreadChannelUpdateListener, getServerThreadChannelAttachableListeners, getServerThreadChannelCreateListeners, getServerThreadChannelDeleteListeners, getServerThreadChannelMembersUpdateListeners, getServerThreadChannelUpdateListeners, removeListener, removeServerThreadChannelAttachableListener

Methods inherited from interface org.javacord.api.util.Specializable

as

Methods inherited from interface org.javacord.api.entity.channel.TextChannel

bulkDelete, bulkDelete, bulkDelete, bulkDelete, canAddNewReactions, canAttachFiles, canEmbedLinks, canManageMessages, canMentionEveryone, canReadMessageHistory, canRemoveReactionsOfOthers, canUseExternalEmojis, canUseTts, canWrite, canYouAddNewReactions, canYouAttachFiles, canYouEmbedLinks, canYouManageMessages, canYouMentionEveryone, canYouReadMessageHistory, canYouRemoveReactionsOfOthers, canYouUseExternalEmojis, canYouUseTts, canYouWrite, deleteMessages, deleteMessages, deleteMessages, deleteMessages, getAllIncomingWebhooks, getIncomingWebhooks, getMessageById, getMessageById, getMessageCache, getMessages, getMessagesAfter, getMessagesAfter, getMessagesAfterAsStream, getMessagesAfterAsStream, getMessagesAfterUntil, getMessagesAfterUntil, getMessagesAfterWhile, getMessagesAfterWhile, getMessagesAround, getMessagesAround, getMessagesAroundAsStream, getMessagesAroundAsStream, getMessagesAroundUntil, getMessagesAroundUntil, getMessagesAroundWhile, getMessagesAroundWhile, getMessagesAsStream, getMessagesBefore, getMessagesBefore, getMessagesBeforeAsStream, getMessagesBeforeAsStream, getMessagesBeforeUntil, getMessagesBeforeUntil, getMessagesBeforeWhile, getMessagesBeforeWhile, getMessagesBetween, getMessagesBetween, getMessagesBetweenAsStream, getMessagesBetweenAsStream, getMessagesBetweenUntil, getMessagesBetweenUntil, getMessagesBetweenWhile, getMessagesBetweenWhile, getMessagesUntil, getMessagesWhile, getPins, getWebhooks, type, typeContinuously, typeContinuously, typeContinuouslyAfter, typeContinuouslyAfter

Methods inherited from interface org.javacord.api.listener.channel.TextChannelAttachableListenerManager

addAutocompleteCreateListener, addButtonClickListener, addCachedMessagePinListener, addCachedMessageUnpinListener, addChannelPinsUpdateListener, addInteractionCreateListener, addMessageComponentCreateListener, addMessageContextMenuCommandListener, addMessageCreateListener, addMessageDeleteListener, addMessageEditListener, addModalSubmitListener, addReactionAddListener, addReactionRemoveAllListener, addReactionRemoveListener, addSelectMenuChooseListener, addSlashCommandCreateListener, addTextChannelAttachableListener, addUserContextMenuCommandListener, addUserStartTypingListener, getAutocompleteCreateListeners, getButtonClickListeners, getCachedMessagePinListeners, getCachedMessageUnpinListeners, getChannelPinsUpdateListeners, getInteractionCreateListeners, getMessageComponentCreateListeners, getMessageContextMenuCommandListeners, getMessageCreateListeners, getMessageDeleteListeners, getMessageEditListeners, getModalSubmitListeners, getReactionAddListeners, getReactionRemoveAllListeners, getReactionRemoveListeners, getSelectMenuChooseListeners, getSlashCommandCreateListeners, getTextChannelAttachableListeners, getUserContextMenuCommandListeners, getUserStartTypingListeners, removeListener, removeTextChannelAttachableListener

Methods inherited from interface org.javacord.api.entity.channel.VoiceChannel

canConnect, canMuteUsers, canYouConnect, canYouMuteUsers

Methods inherited from interface org.javacord.api.listener.channel.VoiceChannelAttachableListenerManager

addVoiceChannelAttachableListener, getVoiceChannelAttachableListeners, removeListener, removeVoiceChannelAttachableListener

Method Detail

getType

default ChannelType getType()

Description copied from interface: Channel

Gets the type of the channel.

Specified by:

getType in interface Channel

Returns:

The type of the channel.

getRecipient

java.util.Optional<User> getRecipient()

Gets the recipient of the private channel. A private channel always consists of yourself and one other user. The user may be missing as discord doesn't always send the required information.

Returns:

The recipient of the private channel.

getRecipientId

java.util.Optional<java.lang.Long> getRecipientId()

Gets the id of the recipient of the private channel. A private channel always consists of yourself and one other user. The id may be missing as discord doesn't always send the required information.

Returns:

The id of the recipient of the private channel.

getCurrentCachedInstance

default java.util.Optional<PrivateChannel> getCurrentCachedInstance()

Description copied from interface: UpdatableFromCache

Gets an updated instance of this entity from the cache. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache, that gets updates from Discord, in case this one was invalidated.

This method returns the currently cached entity, or an empty Optional if the entity is not cached any longer, for example because it was deleted or the message was thrown out of the cache.

Specified by:

getCurrentCachedInstance in interface Channel

Specified by:

getCurrentCachedInstance in interface TextChannel

Specified by:

getCurrentCachedInstance in interface UpdatableFromCache

Specified by:

getCurrentCachedInstance in interface VoiceChannel

Returns:

The current cached instance.

getLatestInstance

default java.util.concurrent.CompletableFuture<PrivateChannel> getLatestInstance()

Description copied from interface: Updatable

Gets an updated instance of this entity from the cache or from Discord directly. This is for example necessary if an instance got invalid by a reconnect to Discord which invalidates all existing instances which means they do not get any further updates from Discord applied. Due to that, references to instances should usually not be held for an extended period of time. If they are, this method can be used to retrieve the current instance from the cache if present or from Discord directly.

This method returns the currently cached entity if present, or request the entity from Discord if it is not cached or not permanently cached. If the entity is a fully cached entity and is not in the cache any longer, for example because it was deleted or the message was thrown out of the cache, the CompletableFuture completes exceptionally with a NoSuchElementException. If a request to Discord is made, the according remote call exception will be used to complete the CompletableFuture exceptionally.

Specified by:

getLatestInstance in interface Channel

Specified by:

getLatestInstance in interface TextChannel

Specified by:

getLatestInstance in interface Updatable

Specified by:

getLatestInstance in interface UpdatableFromCache

Specified by:

getLatestInstance in interface VoiceChannel

Returns:

The current cached instance.