Package net.dv8tion.jda.internal.entities.channel.concrete

Class PrivateChannelImpl

java.lang.Object

net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl<PrivateChannelImpl>

net.dv8tion.jda.internal.entities.channel.concrete.PrivateChannelImpl

All Implemented Interfaces:

Formattable, Channel, PrivateChannel, MessageChannel, ChannelUnion, MessageChannelUnion, IDetachableEntity, IMentionable, ISnowflake, ChannelMixin<PrivateChannelImpl>, PrivateChannelMixin<PrivateChannelImpl>, MessageChannelMixin<PrivateChannelImpl>, IDetachableEntityMixin

public class PrivateChannelImpl
extends AbstractChannelImpl<PrivateChannelImpl>
implements PrivateChannel, PrivateChannelMixin<PrivateChannelImpl>

Field Summary

Fields inherited from interface net.dv8tion.jda.api.entities.channel.Channel

MAX_NAME_LENGTH

Constructor Summary

Constructors

Constructor	Description
PrivateChannelImpl(JDA api, long id, User user)

Method Summary

Modifier and Type	Method	Description
boolean	canDeleteOtherUsersMessages()
boolean	canTalk()	Whether the currently logged in user can send messages in this channel or not.
void	checkCanAccess()
void	checkCanAddReactions()
void	checkCanControlMessagePins()
void	checkCanRemoveReactions()
void	checkCanSendFiles()
void	checkCanSendMessage()
void	checkCanSendMessageEmbeds()
void	checkCanViewHistory()
boolean	equals(Object obj)
long	getLatestMessageIdLong()	The id for the most recent message sent in this current MessageChannel.
String	getName()	The human readable name of this channel.
ChannelType	getType()	The ChannelType for this channel
User	getUser()	The User that this PrivateChannel communicates with.
int	hashCode()
boolean	isDetached()	Whether this entity is detached.
PrivateChannelImpl	setLatestMessageIdLong(long latestMessageId)
void	setUser(User user)

Methods inherited from class net.dv8tion.jda.internal.entities.channel.AbstractChannelImpl

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel, getIdLong, getJDA, setName, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.dv8tion.jda.api.entities.channel.Channel

formatTo, getAsMention, getFlags, getJDA

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.ChannelMixin

delete, setName

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.ChannelUnion

asAudioChannel, asCategory, asForumChannel, asGroupChannel, asGuildChannel, asGuildMessageChannel, asMediaChannel, asMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asStandardGuildChannel, asStandardGuildMessageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.internal.entities.detached.mixin.IDetachableEntityMixin

checkAttached, detachedException, detachedRequiresChannelException

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

getId, getIdLong, getTimeCreated

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

addReactionById, deleteMessageById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageComponentsById, editMessageEmbedsById, editMessageEmbedsById, editMessageEmbedsById, editMessageFormatById, editMessageFormatById, endPollById, endPollById, getHistoryAfter, getHistoryAfter, getHistoryAround, getHistoryAround, getHistoryBefore, getHistoryBefore, getLatestMessageId, pinMessageById, purgeMessages, purgeMessagesById, purgeMessagesById, removeReactionById, retrieveMessageById, retrievePollVotersById, retrievePollVotersById, retrieveReactionUsersById, retrieveReactionUsersById, retrieveReactionUsersById, sendFiles, sendMessageComponents, sendMessageComponents, sendMessageFormat, unpinMessageById

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.middleman.MessageChannelMixin

addReactionById, bulkDeleteMessages, deleteMessageById, editMessageAttachmentsById, editMessageById, editMessageById, editMessageComponentsById, editMessageEmbedsById, getHistory, getHistoryAfter, getHistoryAround, getHistoryBefore, getHistoryFromBeginning, getIterableHistory, pinMessageById, purgeMessages, purgeMessagesById, removeReactionById, retrieveMessageById, retrievePinnedMessages, retrieveReactionUsersById, sendFiles, sendMessage, sendMessage, sendMessageComponents, sendMessageEmbeds, sendMessageEmbeds, sendMessagePoll, sendTyping, unpinMessageById

Methods inherited from interface net.dv8tion.jda.api.entities.channel.unions.MessageChannelUnion

asAudioChannel, asGroupChannel, asGuildMessageChannel, asNewsChannel, asPrivateChannel, asStageChannel, asTextChannel, asThreadChannel, asThreadContainer, asVoiceChannel

Methods inherited from interface net.dv8tion.jda.internal.entities.channel.mixin.concrete.PrivateChannelMixin

retrievePrivateChannel, retrieveUser

Constructor Details

PrivateChannelImpl

public PrivateChannelImpl(JDA api,
 long id,
 @Nullable
 User user)

Method Details

isDetached

public boolean isDetached()

Description copied from interface: IDetachableEntity

Whether this entity is detached.

If this returns true, this entity cannot be retrieved, will never be updated, and most methods that would otherwise return a RestAction will throw a DetachedEntityException instead.

Specified by:

isDetached in interface IDetachableEntity

Returns:

True, if the entity is detached

getType

@Nonnull
public ChannelType getType()

Description copied from interface: Channel

The ChannelType for this channel

Specified by:

getType in interface Channel

Returns:

The channel type

getUser

@Nullable
public User getUser()

Description copied from interface: PrivateChannel

The User that this PrivateChannel communicates with.

This user is only null if this channel is currently uncached, and one the following occur:

• A reaction is removed
• A reaction is added
• A message is deleted
• This account sends a message to a user from another shard (not shard 0)
• This account receives an interaction response, happens when using an user-installed interaction
• This channel represents a DM channel between friends, happens when using an user-installed interaction

The consequence of this is that for any message this bot receives from a guild or from other users, the user will not be null.
In order to retrieve a user that is null, use PrivateChannel.retrieveUser()

Specified by:

getUser in interface PrivateChannel

Returns:

Possibly-null User.

See Also:

• PrivateChannel.retrieveUser()

getName

@Nonnull
public String getName()

Description copied from interface: Channel

The human readable name of this channel.

May be an empty string for GroupChannels with no name (Group DMs with no name displays the recipients on the Discord client).

Specified by:

getName in interface Channel

Specified by:

getName in interface PrivateChannel

Specified by:

getName in interface PrivateChannelMixin<PrivateChannelImpl>

Overrides:

getName in class AbstractChannelImpl<PrivateChannelImpl>

Returns:

The name of this channel

See Also:

• PrivateChannel.retrieveUser()
• PrivateChannel.getUser()

getLatestMessageIdLong

public long getLatestMessageIdLong()

Description copied from interface: MessageChannel

The id for the most recent message sent in this current MessageChannel.

This value is updated on each MessageReceivedEvent and the value might point to an already deleted message since the value is not cleared when the message is deleted, so calling MessageChannel.retrieveMessageById(long) with this id can result in an UNKNOWN_MESSAGE error

Specified by:

getLatestMessageIdLong in interface MessageChannel

Returns:

The most recent message's id or 0 if no messages are present

canTalk

public boolean canTalk()

Description copied from interface: MessageChannel

Whether the currently logged in user can send messages in this channel or not.
For GuildMessageChannel this method checks for both Permission.VIEW_CHANNEL and Permission.MESSAGE_SEND.
For ThreadChannel this method checks for Permission.MESSAGE_SEND_IN_THREADS instead of Permission.MESSAGE_SEND.
For PrivateChannel this method checks if the user that this PrivateChannel communicates with is not a bot, but it does not check if the said user blocked the currently logged in user or have their DMs disabled.
For GroupChannel this method returns false.

Specified by:

canTalk in interface MessageChannel

Returns:

True, if we are able to read and send messages in this channel

checkCanAccess

public void checkCanAccess()

Specified by:

checkCanAccess in interface ChannelMixin<PrivateChannelImpl>

checkCanSendMessage

public void checkCanSendMessage()

Specified by:

checkCanSendMessage in interface MessageChannelMixin<PrivateChannelImpl>

checkCanSendMessageEmbeds

public void checkCanSendMessageEmbeds()

Specified by:

checkCanSendMessageEmbeds in interface MessageChannelMixin<PrivateChannelImpl>

checkCanSendFiles

public void checkCanSendFiles()

Specified by:

checkCanSendFiles in interface MessageChannelMixin<PrivateChannelImpl>

checkCanViewHistory

public void checkCanViewHistory()

Specified by:

checkCanViewHistory in interface MessageChannelMixin<PrivateChannelImpl>

checkCanAddReactions

public void checkCanAddReactions()

Specified by:

checkCanAddReactions in interface MessageChannelMixin<PrivateChannelImpl>

checkCanRemoveReactions

public void checkCanRemoveReactions()

Specified by:

checkCanRemoveReactions in interface MessageChannelMixin<PrivateChannelImpl>

checkCanControlMessagePins

public void checkCanControlMessagePins()

Specified by:

checkCanControlMessagePins in interface MessageChannelMixin<PrivateChannelImpl>

canDeleteOtherUsersMessages

public boolean canDeleteOtherUsersMessages()

Specified by:

canDeleteOtherUsersMessages in interface MessageChannelMixin<PrivateChannelImpl>

setUser

public void setUser(User user)

setLatestMessageIdLong

public PrivateChannelImpl setLatestMessageIdLong(long latestMessageId)

Specified by:

setLatestMessageIdLong in interface MessageChannelMixin<PrivateChannelImpl>

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object