/
ReplyCallbackAction.java
348 lines (328 loc) · 13 KB
/
ReplyCallbackAction.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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
/*
* 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.requests.restaction.interactions;
import net.dv8tion.jda.api.entities.MessageEmbed;
import net.dv8tion.jda.api.interactions.InteractionHook;
import net.dv8tion.jda.api.interactions.components.ActionComponent;
import net.dv8tion.jda.api.interactions.components.ActionRow;
import net.dv8tion.jda.api.interactions.components.ItemComponent;
import net.dv8tion.jda.api.utils.AllowedMentions;
import net.dv8tion.jda.api.utils.AttachmentOption;
import net.dv8tion.jda.internal.utils.Checks;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.io.*;
import java.util.Arrays;
import java.util.Collection;
import java.util.concurrent.TimeUnit;
import java.util.function.BooleanSupplier;
/**
* A {@link InteractionCallbackAction} which can be used to send a message reply for an interaction.
* <br>You can use {@link #setEphemeral(boolean)} to hide this message from other users.
*/
public interface ReplyCallbackAction extends InteractionCallbackAction<InteractionHook>, AllowedMentions<ReplyCallbackAction>
{
@Nonnull
@Override
ReplyCallbackAction setCheck(@Nullable BooleanSupplier checks);
@Nonnull
@Override
ReplyCallbackAction timeout(long timeout, @Nonnull TimeUnit unit);
@Nonnull
@Override
ReplyCallbackAction deadline(long timestamp);
/**
* Add {@link MessageEmbed MessageEmbeds} for the message
*
* @param embeds
* The message embeds to add
*
* @throws IllegalArgumentException
* If null is provided, or one of the embeds is too big
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addEmbeds(@Nonnull MessageEmbed... embeds)
{
Checks.noneNull(embeds, "MessageEmbed");
return addEmbeds(Arrays.asList(embeds));
}
/**
* Add {@link MessageEmbed MessageEmbeds} for the message
*
* @param embeds
* The message embeds to add
*
* @throws IllegalArgumentException
* If null is provided, or one of the embeds is too big
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
ReplyCallbackAction addEmbeds(@Nonnull Collection<? extends MessageEmbed> embeds);
/**
* Add a single {@link ActionRow} to the message.
*
* @param components
* The components for this action row
*
* @throws IllegalArgumentException
* <ul>
* <li>If null is provided, or more than 5 ItemComponents are provided</li>
* <li>If any custom {@link ActionComponent#getId() id} is duplicated</li>
* <li>If any of the provided ItemComponents are not compatible with messages</li>
* </ul>
*
* @return The same reply action, for chaining convenience
*
* @see ActionRow#of(ItemComponent...)
* @see ItemComponent#isMessageCompatible()
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addActionRow(@Nonnull ItemComponent... components)
{
return addActionRows(ActionRow.of(components));
}
/**
* Add a single {@link ActionRow} to the message.
*
* @param components
* The components for this action row
*
* @throws IllegalArgumentException
* <ul>
* <li>If null is provided, or more than 5 ItemComponents are provided</li>
* <li>If any custom {@link ActionComponent#getId() id} is duplicated</li>
* <li>If any of the provided ItemComponents are not compatible with messages</li>
* </ul>
*
* @return The same reply action, for chaining convenience
*
* @see ActionRow#of(Collection)
* @see ItemComponent#isMessageCompatible()
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addActionRow(@Nonnull Collection<? extends ItemComponent> components)
{
return addActionRows(ActionRow.of(components));
}
/**
* Add {@link ActionRow ActionRows} to the message.
*
* @param rows
* The action rows to add
*
* @throws IllegalArgumentException
* <ul>
* <li>If null is provided, or more than 5 action rows are provided</li>
* <li>If any custom {@link ActionComponent#getId() id} is duplicated</li>
* <li>If any of the provided action rows are not compatible with messages</li>
* </ul>
*
* @return The same reply action, for chaining convenience
*
* @see ActionRow#isMessageCompatible()
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addActionRows(@Nonnull Collection<? extends ActionRow> rows)
{
Checks.noneNull(rows, "ActionRows");
return addActionRows(rows.toArray(new ActionRow[0]));
}
/**
* Add {@link ActionRow ActionRows} to the message.
*
* @param rows
* The action rows to add
*
* @throws IllegalArgumentException
* <ul>
* <li>If null is provided, or more than 5 action rows are provided</li>
* <li>If any custom {@link ActionComponent#getId() id} is duplicated</li>
* <li>If any of the provided action rows are not compatible with messages</li>
* </ul>
*
* @return The same reply action, for chaining convenience
*
* @see ActionRow#isMessageCompatible()
*/
@Nonnull
@CheckReturnValue
ReplyCallbackAction addActionRows(@Nonnull ActionRow... rows);
/**
* Set the content for this message.
*
* @param content
* The new message content or null to unset
*
* @throws IllegalArgumentException
* If the provided content is longer than {@link net.dv8tion.jda.api.entities.Message#MAX_CONTENT_LENGTH MAX_CONTENT_LENGTH} characters
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
ReplyCallbackAction setContent(@Nullable final String content);
/**
* Enable/Disable Text-To-Speech for the resulting message.
*
* @param isTTS
* True, if this should cause a Text-To-Speech effect when sent to the channel
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
ReplyCallbackAction setTTS(final boolean isTTS);
/**
* Set whether this message should be visible to other users.
* <br>When a message is ephemeral, it will only be visible to the user that used the interaction.
*
* <p>Ephemeral messages have some limitations and will be removed once the user restarts their client.
* <br>Limitations:
* <ul>
* <li>Cannot be deleted by the bot</li>
* <li>Cannot contain any files/attachments</li>
* <li>Cannot be reacted to</li>
* <li>Cannot be retrieved</li>
* </ul>
*
* @param ephemeral
* True, if this message should be invisible for other users
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
ReplyCallbackAction setEphemeral(boolean ephemeral);
/**
* Adds the provided {@link File}.
* <br><u>The stream will be closed upon execution!</u>
* <br>The provided file will be appended to the message.
*
* @param file
* The {@link File} data to upload in response to the interaction.
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalArgumentException
* If the provided file is {@code null}.
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addFile(@Nonnull File file, @Nonnull AttachmentOption... options)
{
Checks.notNull(file, "File");
return addFile(file, file.getName(), options);
}
/**
* Adds the provided {@link File}.
* <br><u>The stream will be closed upon execution!</u>
* <br>The provided file will be appended to the message.
*
* <p>The {@code name} parameter is used to inform Discord about what the file should be called. This is 2 fold:
* <ol>
* <li>The file name provided is the name that is found in {@link net.dv8tion.jda.api.entities.Message.Attachment#getFileName()}
* after upload and it is the name that will show up in the client when the upload is displayed.
* <br>Note: The fileName does not show up on the Desktop client for images. It does on mobile however.</li>
* <li>The extension of the provided fileName also determines how Discord will treat the file. Discord currently only
* has special handling for image file types, but the fileName's extension must indicate that it is an image file.
* This means it has to end in something like .png, .jpg, .jpeg, .gif, etc. As a note, you can also not provide
* a full name for the file and instead ONLY provide the extension like "png" or "gif" and Discord will generate
* a name for the upload and append the fileName as the extension.</li>
* </ol>
*
* @param file
* The {@link File} data to upload in response to the interaction.
* @param name
* The file name that should be sent to discord
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalArgumentException
* If the provided file or filename is {@code null}.
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addFile(@Nonnull File file, @Nonnull String name, @Nonnull AttachmentOption... options)
{
try
{
Checks.notNull(file, "File");
Checks.check(file.exists() && file.canRead(), "Provided file either does not exist or cannot be read from!");
return addFile(new FileInputStream(file), name, options);
}
catch (FileNotFoundException e)
{
throw new IllegalArgumentException(e);
}
}
/**
* Adds the provided {@code byte[]} as file data.
* <br><u>The stream will be closed upon execution!</u>
* <br>The provided file will be appended to the message.
*
* @param data
* The {@code byte[]} data to upload in response to the interaction.
* @param name
* The file name that should be sent to discord
* <br>Refer to the documentation for {@link #addFile(java.io.File, String, AttachmentOption...)} for information about this parameter.
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalArgumentException
* If the provided data or filename is {@code null}.
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default ReplyCallbackAction addFile(@Nonnull byte[] data, @Nonnull String name, @Nonnull AttachmentOption... options)
{
Checks.notNull(data, "Data");
return addFile(new ByteArrayInputStream(data), name, options);
}
/**
* Adds the provided {@link java.io.InputStream InputStream} as file data.
* <br><u>The stream will be closed upon execution!</u>
* <br>The provided file will be appended to the message.
*
* @param data
* The InputStream data to upload in response to the interaction.
* @param name
* The file name that should be sent to discord
* <br>Refer to the documentation for {@link #addFile(java.io.File, String, AttachmentOption...)} for information about this parameter.
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalArgumentException
* If the provided data or filename is {@code null}.
*
* @return The same reply action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
ReplyCallbackAction addFile(@Nonnull InputStream data, @Nonnull String name, @Nonnull AttachmentOption... options);
}