club.minnced.discord.webhook.receive

Class ReadonlyMessage

java.lang.Object

club.minnced.discord.webhook.receive.ReadonlyMessage

All Implemented Interfaces:

org.json.JSONString

public class ReadonlyMessage
extends java.lang.Object
implements org.json.JSONString

Readonly message representation used for responses of WebhookClient send methods.

See Also:

toWebhookMessage()

Constructor Summary

Constructors

Constructor and Description
ReadonlyMessage(long id, long channelId, boolean mentionsEveryone, boolean tts, int flags, @NotNull ReadonlyUser author, @NotNull java.lang.String content, @NotNull java.util.List<ReadonlyEmbed> embeds, @NotNull java.util.List<ReadonlyAttachment> attachments, @NotNull java.util.List<ReadonlyUser> mentionedUsers, @NotNull java.util.List<java.lang.Long> mentionedRoles)

Method Summary

Modifier and Type	Method and Description
@NotNull java.util.List<ReadonlyAttachment>	getAttachments() The attachments of this message.
@NotNull ReadonlyUser	getAuthor() The author of this message, represented by a ReadonlyUser instance.
long	getChannelId() The channel id for the channel this message was sent in
@NotNull java.lang.String	getContent() The content of this message, this is displayed above embeds and attachments.
@NotNull java.util.List<ReadonlyEmbed>	getEmbeds() The embeds in this message, a webhook can send up to 10 embeds in one message.
int	getFlags() The flags for this message.
long	getId() The id of this message
@NotNull java.util.List<java.lang.Long>	getMentionedRoles() List of mentioned role ids
@NotNull java.util.List<ReadonlyUser>	getMentionedUsers() Users mentioned by this message.
boolean	isMentionsEveryone() Whether this message mentioned everyone/here
boolean	isTTS() Whether this message used Text-to-Speech (TTS)
java.lang.String	toJSONString()
java.lang.String	toString() JSON representation of this provider
@NotNull WebhookMessage	toWebhookMessage() Converts this message to a reduced webhook message.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ReadonlyMessage

public ReadonlyMessage(long id,
                       long channelId,
                       boolean mentionsEveryone,
                       boolean tts,
                       int flags,
                       @NotNull
                       @NotNull ReadonlyUser author,
                       @NotNull
                       @NotNull java.lang.String content,
                       @NotNull
                       @NotNull java.util.List<ReadonlyEmbed> embeds,
                       @NotNull
                       @NotNull java.util.List<ReadonlyAttachment> attachments,
                       @NotNull
                       @NotNull java.util.List<ReadonlyUser> mentionedUsers,
                       @NotNull
                       @NotNull java.util.List<java.lang.Long> mentionedRoles)

Method Detail

getId

public long getId()

The id of this message

Returns:

The id

getChannelId

public long getChannelId()

The channel id for the channel this message was sent in

Returns:

The channel id

isMentionsEveryone

public boolean isMentionsEveryone()

Whether this message mentioned everyone/here

Returns:

True, if this message mentioned everyone/here

isTTS

public boolean isTTS()

Whether this message used Text-to-Speech (TTS)

Returns:

True, if this message used TTS

getFlags

public int getFlags()

The flags for this message.
You can use MessageFlags to determine which flags are set.

Returns:

The flags

getAuthor

@NotNull
public @NotNull ReadonlyUser getAuthor()

The author of this message, represented by a ReadonlyUser instance.

Returns:

The author

getContent

@NotNull
public @NotNull java.lang.String getContent()

The content of this message, this is displayed above embeds and attachments.

Returns:

The content

getEmbeds

@NotNull
public @NotNull java.util.List<ReadonlyEmbed> getEmbeds()

The embeds in this message, a webhook can send up to 10 embeds in one message. Additionally this contains embeds generated from links.

Returns:

List of embeds for this message

getAttachments

@NotNull
public @NotNull java.util.List<ReadonlyAttachment> getAttachments()

The attachments of this message. This contains files added through methods such as WebhookMessageBuilder.addFile(java.io.File).
The attachments only contain meta-data and not the actual files.

Returns:

List of attachments

getMentionedUsers

@NotNull
public @NotNull java.util.List<ReadonlyUser> getMentionedUsers()

Users mentioned by this message.
This will not contain all users when using an everyone/here mention, it only contains directly mentioned users.

Returns:

List of mentioned users.

getMentionedRoles

@NotNull
public @NotNull java.util.List<java.lang.Long> getMentionedRoles()

List of mentioned role ids

Returns:

List of ids for directly mentioned roles

toWebhookMessage

@NotNull
public @NotNull WebhookMessage toWebhookMessage()

Converts this message to a reduced webhook message.
This can be used for sending.

Returns:

WebhookMessage

toString

public java.lang.String toString()

JSON representation of this provider

Overrides:

toString in class java.lang.Object

Returns:

The JSON representation

toJSONString

public java.lang.String toJSONString()

Specified by:

toJSONString in interface org.json.JSONString