/
Emote.java
218 lines (201 loc) · 7.88 KB
/
Emote.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
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
/*
* Copyright 2015-2018 Austin Keener & Michael Ritter & Florian Spieß
*
* 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.core.entities;
import net.dv8tion.jda.client.managers.EmoteManager;
import net.dv8tion.jda.client.managers.EmoteManagerUpdatable;
import net.dv8tion.jda.core.JDA;
import net.dv8tion.jda.core.requests.restaction.AuditableRestAction;
import net.dv8tion.jda.core.utils.PermissionUtil;
import javax.annotation.CheckReturnValue;
import java.util.List;
/**
* Represents a Custom Emote. (Custom Emoji in official Discord API terminology)
*
* <p><b>This does not represent unicode emojis like they are used in the official client! (:smiley: is not a custom emoji)</b>
*
* @since 2.2
* @author Florian Spieß
*/
public interface Emote extends ISnowflake, IMentionable, IFakeable
{
/**
* The {@link net.dv8tion.jda.core.entities.Guild Guild} this emote is attached to.
*
* <p><b>This is null if the emote is fake (retrieved from a Message)</b>
*
* @return Guild of this emote or null if it is a fake entity
*/
Guild getGuild();
/**
* Roles this emote is active for
* <br><a href="https://discordapp.com/developers/docs/resources/guild#emoji-object" target="_blank">Learn More</a>
*
* @throws IllegalStateException
* If this Emote is fake ({@link #isFake()})
*
* @return An immutable list of the roles this emote is active for (all roles if empty)
*/
List<Role> getRoles();
/**
* The name of this emote
*
* @return String representation of this emote's name
*/
String getName();
/**
* Whether this emote is managed. A managed Emote is controlled by Discord, not the Guild administrator, typical
* via a service like BBTV in conjunction with Twitch.
* <br><a href="https://discordapp.com/developers/docs/resources/guild#emoji-object" target="_blank">Learn More</a>
*
* @return True, if this emote is managed
*/
boolean isManaged();
/**
* The {@link net.dv8tion.jda.core.JDA JDA} instance of this Emote
*
* @return The JDA instance of this Emote
*/
JDA getJDA();
/**
* Deletes this Emote.
*
* <p>Possible ErrorResponses include:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_EMOJI UNKNOWN_EMOTE}
* <br>If this Emote was already removed</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_GUILD UNKNOWN_GUILD}
* <br>If the Guild of this Emote was deleted</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>If we were removed from the Guild</li>
* </ul>
*
* @throws IllegalStateException
* if this Emote is fake ({@link #isFake()})
* @throws java.lang.UnsupportedOperationException
* If this emote is managed by discord ({@link #isManaged()})
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* if the Permission {@link net.dv8tion.jda.core.Permission#MANAGE_EMOTES MANAGE_EMOTES} is not given
*
* @return {@link net.dv8tion.jda.core.requests.restaction.AuditableRestAction AuditableRestAction}
* The RestAction to delete this Emote.
*/
@CheckReturnValue
AuditableRestAction<Void> delete();
/**
* The {@link net.dv8tion.jda.client.managers.EmoteManager Manager} for this emote, used to modify
* properties of the emote like name and role restrictions.
*
* <p>This will only work for {@link net.dv8tion.jda.core.AccountType#CLIENT AccountType.CLIENT}.
*
* @throws IllegalStateException
* if this emote is fake
*
* @return The EmoteManager for this Emote
*/
EmoteManager getManager();
/**
* An <b>updatable</b> manager for this Emote, used to modify properties of the emote like name and role restrictions.
*
* <p>This will only work for the client account type.
*
* <p>This specific Manager is used to modify multiple properties at once
* by setting the property and calling {@link EmoteManagerUpdatable#update()}
*
* @throws IllegalStateException
* if this emote is fake
*
* @return The EmoteManagerUpdatable for this Emote
*/
EmoteManagerUpdatable getManagerUpdatable();
/**
* A String representation of the URL which leads to image displayed within the official Discord™ client
* when this Emote is used
*
* @return Discord CDN link to the Emote's image
*/
default String getImageUrl()
{
return "https://cdn.discordapp.com/emojis/" + getId() + ".png";
}
/**
* Usable representation of this Emote (used to display in the client just like mentions with a specific format)
* <br>Emotes are used with the format <code><:{@link #getName getName()}:{@link #getId getId()}></code>
*
* @return A usable String representation for this Emote
*
* @see <a href="https://discordapp.com/developers/docs/resources/channel#message-formatting">Message Formatting</a>
*/
@Override
default String getAsMention()
{
return "<:" + getName() + ":" + getIdLong() + ">";
}
/**
* Whether the specified Member can interact with this Emote
*
* @param issuer
* The User to test
*
* @return True, if the provided Member can use this Emote
*
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(Member, Emote)
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(User, Emote, MessageChannel)
*/
default boolean canInteract(Member issuer)
{
return PermissionUtil.canInteract(issuer, this);
}
/**
* Whether the specified Member can interact with this Emote within the provided MessageChannel
* <br>Same logic as {@link #canInteract(User, MessageChannel, boolean) canInteract(issuer, channel, true)}!
*
* @param issuer
* The User to test
* @param channel
* The MessageChannel to test
*
* @return True, if the provided Member can use this Emote
*
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(Member, Emote)
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(User, Emote, MessageChannel)
*/
default boolean canInteract(User issuer, MessageChannel channel)
{
return PermissionUtil.canInteract(issuer, this, channel);
}
/**
* Whether the specified Member can interact with this Emote within the provided MessageChannel
* <br>Special override to exclude elevated bot permissions in case of (for instance) reacting to messages.
*
* @param issuer
* The User to test
* @param channel
* The MessageChannel to test
* @param botOverride
* Whether bots can use non-managed emotes in other guilds
*
* @return True, if the provided Member can use this Emote
*
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(Member, Emote)
* @see net.dv8tion.jda.core.utils.PermissionUtil#canInteract(User, Emote, MessageChannel, boolean)
*/
default boolean canInteract(User issuer, MessageChannel channel, boolean botOverride)
{
return PermissionUtil.canInteract(issuer, this, channel, botOverride);
}
}