/
WebhookMessageAction.java
401 lines (383 loc) · 16.4 KB
/
WebhookMessageAction.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
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
/*
* 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;
import net.dv8tion.jda.api.entities.Message;
import net.dv8tion.jda.api.entities.MessageEmbed;
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.interactions.components.buttons.Button;
import net.dv8tion.jda.api.requests.RestAction;
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.ArrayList;
import java.util.Collection;
import java.util.Collections;
/**
* Extension of a default {@link net.dv8tion.jda.api.requests.RestAction RestAction}
* that allows setting message information before sending!
*
* <p>This is available as return type of all sendMessage/sendFile methods in {@link net.dv8tion.jda.api.entities.WebhookClient WebhookClient}.
*
* <p><u>When this RestAction has been executed all provided files will be closed.</u>
* <br>Note that the garbage collector also frees opened file streams when it finalizes the stream object.
*
* @since 4.3.0
*
* @see net.dv8tion.jda.api.entities.WebhookClient#sendMessage(String)
*/
// TODO: WebhookMessage type (no channel/guild attached)
public interface WebhookMessageAction<T> extends RestAction<T>, AllowedMentions<WebhookMessageAction<T>>
{
// /**
// * Set the apparent username for the message author.
// * <br>This changes the username that is shown for the message author.
// *
// * <p>This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}!
// *
// * @param name
// * The username to use, or null to use the default
// *
// * @return The same message action, for chaining convenience
// */
// @Nonnull
// @CheckReturnValue
// WebhookMessageAction<T> setUsername(@Nullable String name);
//
// /**
// * Set the apparent avatar for the message author.
// * <br>This changes the avatar that is shown for the message author.
// *
// * <p>This cannot be used with {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}!
// *
// * @param iconUrl
// * The URL to the avatar, or null to use default
// *
// * @return The same message action, for chaining convenience
// */
// @Nonnull
// @CheckReturnValue
// WebhookMessageAction<T> setAvatarUrl(@Nullable String iconUrl);
/**
* 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>
*
* <p>This only works on {@link net.dv8tion.jda.api.interactions.InteractionHook InteractionHooks}!
*
* @param ephemeral
* True, if this message should be invisible for other users
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> setEphemeral(boolean ephemeral);
/**
* Set the content for this message.
*
* @param content
* The new message content
*
* @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 message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> setContent(@Nullable String content);
/**
* Enable/Disable Text-To-Speech for the resulting message.
*
* @param tts
* True, if this should cause a Text-To-Speech effect when sent to the channel
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> setTTS(boolean tts);
/**
* Add {@link MessageEmbed MessageEmbeds} to this 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 message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> addEmbeds(@Nonnull Collection<? extends MessageEmbed> embeds); // Doesn't work on ephemeral messages!
/**
* Add {@link MessageEmbed MessageEmbeds} to this message
*
* @param embed
* The first message embed to add
* @param other
* Additional message embeds to add
*
* @throws IllegalArgumentException
* If null is provided, or one of the embeds is too big
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addEmbeds(@Nonnull MessageEmbed embed, @Nonnull MessageEmbed... other)
{
ArrayList<MessageEmbed> embeds = new ArrayList<>();
embeds.add(embed);
Collections.addAll(embeds, other);
return addEmbeds(embeds);
}
/**
* Adds the provided {@link java.io.InputStream InputStream} as file data.
* <br><u>The stream will be closed upon execution!</u>
*
* @param data
* The InputStream that will be interpreted as file data
* @param name
* The file name that should be used to interpret the type of the given data
* using the file-name extension. This name is similar to what will be visible
* through {@link net.dv8tion.jda.api.entities.Message.Attachment#getFileName() Message.Attachment.getFileName()}
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalStateException
* If the file limit of {@value Message#MAX_FILE_AMOUNT} has been reached prior to calling this method
* @throws java.lang.IllegalArgumentException
* If the provided data is {@code null} or the provided name is blank or {@code null}
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If this is targeting a TextChannel and the currently logged in account does not have
* {@link net.dv8tion.jda.api.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> addFile(@Nonnull InputStream data, @Nonnull String name, @Nonnull AttachmentOption... options);
/**
* Adds the provided byte[] as file data.
*
* @param data
* The byte[] that will be interpreted as file data
* @param name
* The file name that should be used to interpret the type of the given data
* using the file-name extension. This name is similar to what will be visible
* through {@link net.dv8tion.jda.api.entities.Message.Attachment#getFileName() Message.Attachment.getFileName()}
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalStateException
* If the file limit of {@value Message#MAX_FILE_AMOUNT} has been reached prior to calling this method
* @throws java.lang.IllegalArgumentException
* If the provided data is {@code null} or the provided name is blank or {@code null}
* or if the provided data exceeds the maximum file size of the currently logged in account
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If this is targeting a TextChannel and the currently logged in account does not have
* {@link net.dv8tion.jda.api.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}
*
* @return The same message action, for chaining convenience
*
* @see net.dv8tion.jda.api.entities.SelfUser#getAllowedFileSize() SelfUser.getAllowedFileSize()
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addFile(@Nonnull byte[] data, @Nonnull String name, @Nonnull AttachmentOption... options)
{
Checks.notNull(name, "Name");
Checks.notNull(data, "Data");
return addFile(new ByteArrayInputStream(data), name, options);
}
/**
* Adds the provided {@link java.io.File File} as file data.
*
* <br><u>This method opens a {@link java.io.FileInputStream FileInputStream} which will be closed by executing this action!</u>
*
* @param file
* The File that will be interpreted as file data
* @param name
* The file name that should be used to interpret the type of the given data
* using the file-name extension. This name is similar to what will be visible
* through {@link net.dv8tion.jda.api.entities.Message.Attachment#getFileName() Message.Attachment.getFileName()}
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalStateException
* If the file limit of {@value Message#MAX_FILE_AMOUNT} has been reached prior to calling this method
* @throws java.lang.IllegalArgumentException
* If the provided file is {@code null} or the provided name is blank or {@code null}
* or if the provided file is bigger than the maximum file size of the currently logged in account,
* or if the provided file does not exist/ is not readable
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If this is targeting a TextChannel and the currently logged in account does not have
* {@link net.dv8tion.jda.api.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}
*
* @return The same message action, for chaining convenience
*
* @see net.dv8tion.jda.api.entities.SelfUser#getAllowedFileSize() SelfUser.getAllowedFileSize()
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addFile(@Nonnull File file, @Nonnull String name, @Nonnull AttachmentOption... options)
{
Checks.notEmpty(name, "Name");
Checks.notNull(file, "File");
try
{
return addFile(new FileInputStream(file), name, options);
}
catch (FileNotFoundException e)
{
throw new IllegalArgumentException(e);
}
}
/**
* Adds the provided {@link java.io.File File} as file data.
* <br>Shortcut for {@link #addFile(java.io.File, String, net.dv8tion.jda.api.utils.AttachmentOption...) addFile(file, file.getName())} with the same side-effects.
*
* @param file
* The File that will be interpreted as file data
* @param options
* Possible options to apply to this attachment, such as marking it as spoiler image
*
* @throws java.lang.IllegalStateException
* If the file limit of {@value Message#MAX_FILE_AMOUNT} has been reached prior to calling this method
* @throws java.lang.IllegalArgumentException
* If the provided file is {@code null} or if the provided File is bigger than the maximum file size of the currently logged in account
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If this is targeting a TextChannel and the currently logged in account does not have
* {@link net.dv8tion.jda.api.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}
*
* @return The same message action, for chaining convenience
*
* @see net.dv8tion.jda.api.entities.SelfUser#getAllowedFileSize() SelfUser.getAllowedFileSize()
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addFile(@Nonnull File file, @Nonnull AttachmentOption... options)
{
Checks.notNull(file, "File");
return addFile(file, file.getName(), options);
}
/**
* Add one {@link ActionRow ActionRow} for the message.
*
* @param components
* The components for the action row, such as {@link Button Button}
*
* @throws IllegalArgumentException
* If null is provided, an invalid number of components is provided,
* or any custom {@link ActionComponent#getId() id} is duplicated
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addActionRow(@Nonnull ItemComponent... components)
{
return addActionRows(ActionRow.of(components));
}
/**
* Add one {@link ActionRow ActionRow} for the message.
*
* @param components
* The components for the action row, such as {@link Button Button}
*
* @throws IllegalArgumentException
* If null is provided, an invalid number of components is provided,
* or any custom {@link ActionComponent#getId() id} is duplicated
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addActionRow(@Nonnull Collection<? extends ItemComponent> components)
{
return addActionRows(ActionRow.of(components));
}
/**
* Add {@link ActionRow ActionRows} for the message.
*
* @param rows
* The action rows to add
*
* @throws IllegalArgumentException
* If null is provided, more than 5 action rows are provided,
* or any custom {@link ActionComponent#getId() id} is duplicated
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
default WebhookMessageAction<T> addActionRows(@Nonnull Collection<? extends ActionRow> rows)
{
Checks.noneNull(rows, "ActionRows");
return addActionRows(rows.toArray(new ActionRow[0]));
}
/**
* Add {@link ActionRow ActionRows} for the message.
*
* @param rows
* The action rows to add
*
* @throws IllegalArgumentException
* If null is provided, more than 5 action rows are provided,
* or any custom {@link ActionComponent#getId() id} is duplicated
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> addActionRows(@Nonnull ActionRow... rows);
/**
* Applies the sendable information of the provided {@link net.dv8tion.jda.api.entities.Message Message}
* to this message action settings.
* <br>This will override all existing settings <b>if</b> new settings are available.
*
* <p><b>This does not copy files!</b>
*
* @param message
* The Message to apply settings from
*
* @throws java.lang.IllegalArgumentException
* If the message contains a {@link net.dv8tion.jda.api.entities.MessageEmbed MessageEmbed}
* that exceeds the sendable character limit,
* see {@link net.dv8tion.jda.api.entities.MessageEmbed#isSendable() MessageEmbed.isSendable()}
*
* @return The same message action, for chaining convenience
*/
@Nonnull
@CheckReturnValue
WebhookMessageAction<T> applyMessage(@Nonnull Message message);
}