/
MessageData.java
122 lines (109 loc) · 4.1 KB
/
MessageData.java
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
/*
* Copyright 2015 Austin Keener, Michael Ritter, Florian Spieß, and the JDA contributors
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.api.utils.messages;
import net.dv8tion.jda.api.entities.Message;
import net.dv8tion.jda.api.entities.MessageEmbed;
import net.dv8tion.jda.api.interactions.components.LayoutComponent;
import net.dv8tion.jda.api.utils.AttachedFile;
import javax.annotation.Nonnull;
import java.util.Collection;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
/**
* Represents data relevant to all message requests.
*/
public interface MessageData
{
/**
* The configured message content, this is the opposite for {@link MessageRequest#setContent(String)} and only returns what was set using that setter.
*
* <p>For message edit requests, this will not be the current content of the message.
*
* @return The currently configured content, or an empty string if none was set yet
*
* @see MessageRequest#setContent(String)
*/
@Nonnull
String getContent();
/**
* The configured message embeds, this is the opposite of {@link MessageRequest#setEmbeds(Collection)} and only returns what was set using that setter.
*
* <p>For message edit requests, this will not be the current embeds of the message.
*
* @return The currently configured embeds, or an empty list if none were set yet
*
* @see MessageRequest#setEmbeds(Collection)
*/
@Nonnull
List<MessageEmbed> getEmbeds();
/**
* The configured message components, this is the opposite of {@link MessageRequest#setComponents(Collection)} and only returns what was set using that setter.
*
* <p>For message edit requests, this will not be the current components of the message.
*
* @return The currently configured components, or an empty list if none were set yet
*
* @see MessageRequest#setEmbeds(Collection)
*/
@Nonnull
List<LayoutComponent> getComponents();
// Returns attachment interface for abstraction purposes, however you can only abstract the setter to allow FileUploads
/**
* The configured message attachments as {@link AttachedFile}, this is the opposite of {@link MessageRequest#setFiles(Collection)} and only returns what was set using that setter.
*
* <p>For message edit requests, this will not be the current file attachments of the message.
*
* @return The currently configured attachments, or an empty list if none were set yet
*
* @see MessageRequest#setFiles(Collection)
*/
@Nonnull
List<? extends AttachedFile> getAttachments();
/**
* Whether embeds will be suppressed on this message.
*
* @return True, if embeds are suppressed
*/
boolean isSuppressEmbeds();
/**
* The IDs for users which are allowed to be mentioned, or an empty list.
*
* @return The user IDs which are mention whitelisted
*/
@Nonnull
Set<String> getMentionedUsers();
/**
* The IDs for roles which are allowed to be mentioned, or an empty list.
*
* @return The role IDs which are mention whitelisted
*/
@Nonnull
Set<String> getMentionedRoles();
/**
* The mention types which are whitelisted.
*
* @return The mention types which can be mentioned by this message
*/
@Nonnull
EnumSet<Message.MentionType> getAllowedMentions();
/**
* Whether this message would mention a user, if it is sent as a reply.
*
* @return True, if this would mention with the reply
*/
boolean isMentionRepliedUser();
}