net.dv8tion.jda.entities

Interface Message

All Known Implementing Classes:

MessageImpl

public interface Message

Represents a Text message received from Discord.
This repsents message received from both TextChannels and from PrivateChannels.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Message.Attachment Represents a Message file attachment.

Method Summary

Modifier and Type	Method and Description
void	deleteMessage() Deletes this Message from the server.
java.util.List<Message.Attachment>	getAttachments() An unmodifiable list of Attachment that are attached to this message. Most likely this will only ever be 1 Attachment at most.
User	getAuthor() The author of this Message
java.lang.String	getChannelId() Returns the Id of the Channel this Message was sent in.
java.lang.String	getContent() The textual content of this message.
java.time.OffsetDateTime	getEditedTimestamp() Gives a copy of the Object holding the time this message was last recently updated If this message was never updated (isEdited() returns false), this will be NULL
java.lang.String	getId() The Id of this Message
JDA	getJDA() Returns the JDA instance of this Message
java.util.List<TextChannel>	getMentionedChannels() A immutable list of all mentioned TextChannels.
java.util.List<User>	getMentionedUsers() A immutable list of all mentioned users.
java.lang.String	getRawContent() The raw textual content of this message.
java.lang.String	getStrippedContent() The content, with all its formatting characters stripped.
java.time.OffsetDateTime	getTime() Gives a copy of the Object holding the time this message was originally sent
boolean	isEdited() Returns true, if this Message was edited as least once
boolean	isPrivate() Checks, whether this Message was sent in a PrivateChannel (Private Message), or in a TextChannel (sent in Guild channel)
boolean	isTTS() Is this Message supposed to be TTS (Text-to-speach)
boolean	mentionsEveryone() Is this Message mentioning everyone using @everyone? In PrivateChannel's, this always returns false
Message	updateMessage(java.lang.String newContent) Edits this Messages content to the provided String.

Method Detail

getId

java.lang.String getId()

The Id of this Message

Returns:

String Id

getMentionedUsers

java.util.List<User> getMentionedUsers()

A immutable list of all mentioned users. if noone was mentioned, this list is empty In PrivateChannel's, this always returns an empty List

Returns:

immutable list of mentioned users

getMentionedChannels

java.util.List<TextChannel> getMentionedChannels()

A immutable list of all mentioned TextChannels. if none was mentioned, this list is empty In PrivateChannel's, this always returns an empty List

Returns:

immutable list of mentioned TextChannels

mentionsEveryone

boolean mentionsEveryone()

Is this Message mentioning everyone using @everyone? In PrivateChannel's, this always returns false

Returns:

if mentioning everyone

getTime

java.time.OffsetDateTime getTime()

Gives a copy of the Object holding the time this message was originally sent

Returns:

time of Message

isEdited

boolean isEdited()

Returns true, if this Message was edited as least once

Returns:

if edited

getEditedTimestamp

java.time.OffsetDateTime getEditedTimestamp()

Gives a copy of the Object holding the time this message was last recently updated If this message was never updated (isEdited() returns false), this will be NULL

Returns:

time of most recent update

getAuthor

User getAuthor()

The author of this Message

Returns:

Message author

getContent

java.lang.String getContent()

The textual content of this message. Mentioned users will get returned as @Username If you want the actual Content (mentions as <@id>), use getRawContent() instead

Returns:

message-text

getRawContent

java.lang.String getRawContent()

The raw textual content of this message. Mentioned users will get returned as <@id>

Returns:

raw message-text

getStrippedContent

java.lang.String getStrippedContent()

The content, with all its formatting characters stripped. All remaining characters used in formatting (the ones that did not have a matching partner) are getting escaped. Mentioned users will get returned as @Username

Returns:

message-text with stripped formatting

isPrivate

boolean isPrivate()

Checks, whether this Message was sent in a PrivateChannel (Private Message), or in a TextChannel (sent in Guild channel)

Returns:

true, if this Message is from a PrivateChannel, false if it is from a TextChannel

getChannelId

java.lang.String getChannelId()

Returns the Id of the Channel this Message was sent in. This can be the id of either a TextChannel or a PrivateChannel To get the corresponding channel, you can use JDA.getTextChannelById(String) or JDA.getPrivateChannelById(String) (Hint: isPrivate() could be helpful!)

Returns:

The Id of the Channel this was sent in

getAttachments

java.util.List<Message.Attachment> getAttachments()

An unmodifiable list of Attachment that are attached to this message.
Most likely this will only ever be 1 Attachment at most.

Returns:

Unmodifiable list of Attachments.

isTTS

boolean isTTS()

Is this Message supposed to be TTS (Text-to-speach)

Returns:

if message is tts

updateMessage

Message updateMessage(java.lang.String newContent)

Edits this Messages content to the provided String. If The Message was not created by this account, this does not have any effect If this method failed, null gets returned

Parameters:

newContent - the new content of the Message

Returns:

a new Message-Object for the edited message

deleteMessage

void deleteMessage()

Deletes this Message from the server. Calling this function on a Message created by another User while not having the MESSAGE_MANAGE Permission will have no effect

getJDA

JDA getJDA()

Returns the JDA instance of this Message

Returns:

the corresponding JDA instance