-
-
Notifications
You must be signed in to change notification settings - Fork 724
/
MessageChannel.java
2108 lines (2027 loc) · 118 KB
/
MessageChannel.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*
* Copyright 2015-2017 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 com.mashape.unirest.http.Unirest;
import com.mashape.unirest.request.body.MultipartBody;
import net.dv8tion.jda.core.AccountType;
import net.dv8tion.jda.core.JDA;
import net.dv8tion.jda.core.MessageBuilder;
import net.dv8tion.jda.core.entities.impl.MessageImpl;
import net.dv8tion.jda.core.exceptions.AccountTypeException;
import net.dv8tion.jda.core.requests.*;
import net.dv8tion.jda.core.requests.restaction.AuditableRestAction;
import net.dv8tion.jda.core.requests.restaction.pagination.MessagePaginationAction;
import net.dv8tion.jda.core.utils.IOUtil;
import net.dv8tion.jda.core.utils.MiscUtil;
import org.apache.http.util.Args;
import org.json.JSONArray;
import org.json.JSONObject;
import java.io.File;
import java.io.IOException;
import java.io.InputStream;
import java.util.*;
/**
* Represents a Discord channel that can have {@link net.dv8tion.jda.core.entities.Message Messages} and files sent to it.
*
* <h1>Formattable</h1>
* This interface extends {@link java.util.Formattable Formattable} and can be used with a {@link java.util.Formatter Formatter}
* such as used by {@link String#format(String, Object...) String.format(String, Object...)}
* or {@link java.io.PrintStream#printf(String, Object...) PrintStream.printf(String, Object...)}.
*
* <p>This will use {@link #getName()} rather than {@link Object#toString()}!
* <br>Supported Features:
* <ul>
* <li><b>Alternative</b>
* <br> - Prepends the name with {@code #}
* (Example: {@code %#s} - results in <code>#{@link #getName()}</code>)</li>
*
* <li><b>Width/Left-Justification</b>
* <br> - Ensures the size of a format
* (Example: {@code %20s} - uses at minimum 20 chars;
* {@code %-10s} - uses left-justified padding)</li>
*
* <li><b>Precision</b>
* <br> - Cuts the content to the specified size
* (Example: {@code %.20s})</li>
* </ul>
*
* <p>More information on formatting syntax can be found in the {@link java.util.Formatter format syntax documentation}!
* <br><b>{@link net.dv8tion.jda.core.entities.TextChannel TextChannel} is a special case which uses {@link IMentionable#getAsMention() IMentionable.getAsMention()}
* by default and uses the <code>#{@link #getName()}</code> format as <u>alternative</u></b>
*/
public interface MessageChannel extends ISnowflake, Formattable
{
/**
* The id for the most recent message sent
* in this current MessageChannel.
* <br>This should only be used if {@link #hasLatestMessage()} returns {@code true}!
*
* <p>This value is updated on each {@link net.dv8tion.jda.core.events.message.MessageReceivedEvent MessageReceivedEvent}
* and <u><b>will be reset to {@code null} if the message associated with this ID gets deleted</b></u>
*
* @throws java.lang.IllegalStateException
* If no message id is available
*
* @return The most recent message's id
*/
default String getLatestMessageId()
{
return Long.toUnsignedString(getLatestMessageIdLong());
}
/**
* The id for the most recent message sent
* in this current MessageChannel.
* <br>This should only be used if {@link #hasLatestMessage()} returns {@code true}!
*
* <p>This value is updated on each {@link net.dv8tion.jda.core.events.message.MessageReceivedEvent MessageReceivedEvent}
* and <u><b>will be reset to {@code null} if the message associated with this ID gets deleted</b></u>
*
* @throws java.lang.IllegalStateException
* If no message id is available
*
* @return The most recent message's id
*/
long getLatestMessageIdLong();
/**
* Whether this MessageChannel contains a tracked most recent
* message or not.
*
* <p>This does not directly mean that {@link #getHistory()} will be unable to retrieve past messages,
* it merely means that the latest message is untracked by our internal cache meaning that
* if this returns {@code false} the {@link #getLatestMessageId()} method will throw an {@link java.lang.IllegalStateException IllegalStateException}
*
* @return True, if a latest message id is available for retrieval by {@link #getLatestMessageId()}
*
* @see #getLatestMessageId()
*/
boolean hasLatestMessage();
/**
* This method is a shortcut method to return the following information in the following situation:
* If the MessageChannel is instance of..
* <ul>
* <li><b>TextChannel</b> - Returns {@link TextChannel#getName()}</li>
* <li><b>PrivateChannel</b> Returns {@link PrivateChannel#getUser()}{@link net.dv8tion.jda.core.entities.User#getName() .getName()}</li>
* <li><b>Group</b> - Returns {@link net.dv8tion.jda.client.entities.Group#getName() Group.getName()}</li>
* </ul>
*
* @return Possibly-null "name" of the MessageChannel. Different implementations determine what the name. Only
* {@link net.dv8tion.jda.client.entities.Group Group} could have a {@code null} name.
*/
String getName();
/**
* The {@link net.dv8tion.jda.core.entities.ChannelType ChannelType} of this MessageChannel.
*
* @return The ChannelType for this channel
*/
ChannelType getType();
/**
* Returns the {@link net.dv8tion.jda.core.JDA JDA} instance of this MessageChannel
*
* @return the corresponding JDA instance
*/
JDA getJDA();
/**
* Sends a plain text message to this channel.
* <br>This will fail if this channel is an instance of {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and
* the currently logged in account does not have permissions to send a message to this channel.
* <br>To determine if you are able to send a message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* use {@link net.dv8tion.jda.core.entities.TextChannel#canTalk() TextChannel.canTalk()}.
*
* <p>This method is a shortcut to {@link #sendMessage(Message)} by way of using a {@link net.dv8tion.jda.core.MessageBuilder MessageBuilder}
* internally to build the provided {@code text} into a Message.
* <pre>sendMessage(new MessageBuilder().append(text).build())</pre>
*
* <p>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to {@link #sendMessage(Message)}.
*
* @param text
* the text to build into a Message to send to the MessageChannel.
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does
* not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* </ul>
* @throws net.dv8tion.jda.client.exceptions.VerificationLevelException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel} and
* {@link net.dv8tion.jda.core.entities.TextChannel#getGuild() TextChannel.getGuild()}{@link net.dv8tion.jda.core.entities.Guild#checkVerification() .checkVerification()}
* returns false.
* @throws java.lang.IllegalArgumentException
* if the provided text is null, empty or longer than 2000 characters
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The newly created Message after it has been sent to Discord.
*
* @see net.dv8tion.jda.core.MessageBuilder
*/
default RestAction<Message> sendMessage(String text)
{
Args.notEmpty(text, "Provided text for message");
Args.check(text.length() <= 2000, "Provided text for message must be less than 2000 characters in length");
return sendMessage(new MessageBuilder().append(text).build());
}
/**
* Sends a formatted text message to this channel.
* <br>This will fail if this channel is an instance of {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and
* the currently logged in account does not have permissions to send a message to this channel.
* <br>To determine if you are able to send a message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* use {@link net.dv8tion.jda.core.entities.TextChannel#canTalk() TextChannel.canTalk()}.
*
* <p>This method is a shortcut to {@link #sendMessage(Message)} by way of using a {@link net.dv8tion.jda.core.MessageBuilder MessageBuilder}
* and using its {@link net.dv8tion.jda.core.MessageBuilder#appendFormat(String, Object...)} method.
* <br>For more information on how to format your input, refer to the docs of the method mentioned above.
*
* <p>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to {@link #sendMessage(Message)}.
*
* @param format
* The string that should be formatted, if this is {@code null} or empty
* the content of the Message would be empty and cause a builder exception.
* @param args
* The arguments for your format
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does
* not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* </ul>
* @throws net.dv8tion.jda.client.exceptions.VerificationLevelException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel} and
* {@link net.dv8tion.jda.core.entities.TextChannel#getGuild() TextChannel.getGuild()}{@link net.dv8tion.jda.core.entities.Guild#checkVerification() .checkVerification()}
* returns false.
* @throws java.lang.IllegalArgumentException
* If the provided format text is {@code null}, empty or longer than 2000 characters
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The newly created Message after it has been sent to Discord.
*/
default RestAction<Message> sendMessageFormat(String format, Object... args)
{
Args.notEmpty(format, "Format");
return sendMessage(new MessageBuilder().appendFormat(format, args).build());
}
/**
* Sends a specified {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed} as a {@link net.dv8tion.jda.core.entities.Message Message}
* to this channel.
* <br>This will fail if this channel is an instance of {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and
* the currently logged in account does not have permissions to send a message to this channel.
* <br>To determine if you are able to send a message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* use {@link net.dv8tion.jda.core.entities.TextChannel#canTalk() TextChannel#canTalk}.
*
* <p>This method is a shortcut to {@link #sendMessage(Message)} by way of using a {@link net.dv8tion.jda.core.MessageBuilder MessageBuilder}
* internally to build the provided {@code embed} into a Message.
* <pre>sendMessage(new MessageBuilder().setEmbed(embed).build())</pre>
*
* <p>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to {@link #sendMessage(Message)}.
*
* @param embed
* the {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed} to send
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does
* not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_EMBED_LINKS Permission.MESSAGE_EMBED_LINKS}</li>
* </ul>
* @throws net.dv8tion.jda.client.exceptions.VerificationLevelException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel} and
* {@link net.dv8tion.jda.core.entities.TextChannel#getGuild() TextChannel.getGuild()}{@link net.dv8tion.jda.core.entities.Guild#checkVerification() .checkVerification()}
* returns false.
* @throws java.lang.IllegalArgumentException
* If the provided embed is {@code null} or if the provided {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed}
* is not {@link net.dv8tion.jda.core.entities.MessageEmbed#isSendable(net.dv8tion.jda.core.AccountType) sendable}
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The newly created Message after it has been sent to Discord.
*
* @see net.dv8tion.jda.core.MessageBuilder
* @see net.dv8tion.jda.core.EmbedBuilder
*/
default RestAction<Message> sendMessage(MessageEmbed embed)
{
Args.notNull(embed, "Provided embed");
return sendMessage(new MessageBuilder().setEmbed(embed).build());
}
/**
* Sends a specified {@link net.dv8tion.jda.core.entities.Message Message} to this channel.
* <br>This will fail if this channel is an instance of {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and
* the currently logged in account does not have permissions to send a message to this channel.
* <br>To determine if you are able to send a message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* use {@link net.dv8tion.jda.core.entities.TextChannel#canTalk() TextChannel#canTalk}.
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The send request was attempted after the account lost {@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE} in
* the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNAUTHORIZED UNAUTHORIZED}
* <br>If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} and the recipient User blocked you</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#CANNOT_SEND_TO_USER CANNOT_SEND_TO_USER}
* <br>If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} and the currently logged in account
* does not share any Guilds with the recipient User</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The send request was attempted after the channel was deleted.</li>
* </ul>
*
* @param msg
* the {@link net.dv8tion.jda.core.entities.Message Message} to send
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does
* not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_EMBED_LINKS Permission.MESSAGE_EMBED_LINKS} (if this message is only an embed)</li>
* </ul>
* @throws net.dv8tion.jda.client.exceptions.VerificationLevelException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel} and
* {@link net.dv8tion.jda.core.entities.TextChannel#getGuild() TextChannel.getGuild()}{@link net.dv8tion.jda.core.entities.Guild#checkVerification() .checkVerification()}
* returns false.
* @throws java.lang.IllegalArgumentException
* If the provided message is {@code null} or the provided {@link net.dv8tion.jda.core.entities.Message Message}
* contains an {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed}
* that is not {@link net.dv8tion.jda.core.entities.MessageEmbed#isSendable(net.dv8tion.jda.core.AccountType) sendable}
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The newly created Message after it has been sent to Discord.
*
* @see net.dv8tion.jda.core.MessageBuilder
*/
default RestAction<Message> sendMessage(Message msg)
{
Args.notNull(msg, "Message");
if (!msg.getEmbeds().isEmpty())
{
AccountType type = getJDA().getAccountType();
MessageEmbed embed = msg.getEmbeds().get(0);
Args.check(embed.isSendable(type),
"Provided Message contains an embed with a length greater than %d characters, which is the max for %s accounts!",
type == AccountType.BOT ? MessageEmbed.EMBED_MAX_LENGTH_BOT : MessageEmbed.EMBED_MAX_LENGTH_CLIENT, type);
}
Route.CompiledRoute route = Route.Messages.SEND_MESSAGE.compile(getId());
JSONObject json = ((MessageImpl) msg).toJSONObject();
return new RestAction<Message>(getJDA(), route, json)
{
@Override
protected void handleResponse(Response response, Request<Message> request)
{
if (response.isOk())
{
Message m = api.getEntityBuilder().createMessage(response.getObject(), MessageChannel.this, false);
request.onSuccess(m);
}
else
{
request.onFailure(response);
}
}
};
}
/**
* Uploads a file to the Discord servers and sends it to this {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* Sends the provided {@link net.dv8tion.jda.core.entities.Message Message} with the uploaded file.
* <br>If you do not wish to send a Message with the uploaded file, you can provide {@code null} for
* the {@code message} parameter.
*
* <p>This is a shortcut to {@link #sendFile(java.io.File, String, Message)} by way of using {@link java.io.File#getName()}.
* <pre>sendFile(file, file.getName(), message)</pre>
*
* <p>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to the documentation for {@link #sendFile(java.io.File, String, Message)}.
*
* @param file
* The file to upload to the {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* @param message
* The message to be sent along with the uploaded file. This value can be {@code null}.
*
* @throws IOException
* If an I/O error occurs while reading the File.
* @throws java.lang.IllegalArgumentException
* <ul>
* <li>Provided {@code file} is null.</li>
* <li>Provided {@code file} does not exist.</li>
* <li>Provided {@code file} is unreadable.</li>
* <li>Provided {@code file} is greater than 8MB.</li>
* <li>Provided {@link net.dv8tion.jda.core.entities.Message Message} is not {@code null} <b>and</b>
* contains a {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed} which
* is not {@link net.dv8tion.jda.core.entities.MessageEmbed#isSendable(net.dv8tion.jda.core.AccountType) sendable}</li>
* </ul>
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}</li>
* </ul>
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The {@link net.dv8tion.jda.core.entities.Message Message} created from this upload.
*/
default RestAction<Message> sendFile(File file, Message message) throws IOException
{
Args.notNull(file, "file");
return sendFile(file, file.getName(), message);
}
/**
* Uploads a file to the Discord servers and sends it to this {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* Sends the provided {@link net.dv8tion.jda.core.entities.Message Message} with the uploaded file.
* <br>If you do not wish to send a Message with the uploaded file, you can provide {@code null} for
* the {@code message} parameter.
*
* <p>The {@code fileName} 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.core.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 who 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>
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The send request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The send request was attempted after the account lost {@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE} or
* {@link net.dv8tion.jda.core.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}
* in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNAUTHORIZED UNAUTHORIZED}
* <br>If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} and the recipient User blocked you</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#CANNOT_SEND_TO_USER CANNOT_SEND_TO_USER}
* <br>If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} and the currently logged in account
* does not share any Guilds with the recipient User</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The send request was attempted after the channel was deleted.</li>
* </ul>
*
* @param file
* The file to upload to the {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* @param fileName
* The name that should be sent to discord
* @param message
* The message to be sent along with the uploaded file. This value can be {@code null}.
*
* @throws IOException
* If an I/O error occurs while reading the File.
* @throws java.lang.IllegalArgumentException
* <ul>
* <li>Provided {@code file} is null.</li>
* <li>Provided {@code file} does not exist.</li>
* <li>Provided {@code file} is unreadable.</li>
* <li>Provided {@code file} is greater than 8MB.</li>
* <li>Provided {@link net.dv8tion.jda.core.entities.Message Message} is not {@code null} <b>and</b>
* contains a {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed} which
* is not {@link net.dv8tion.jda.core.entities.MessageEmbed#isSendable(net.dv8tion.jda.core.AccountType) sendable}</li>
* </ul>
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}</li>
* </ul>
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The {@link net.dv8tion.jda.core.entities.Message Message} created from this upload.
*/
default RestAction<Message> sendFile(File file, String fileName, Message message) throws IOException
{
Args.notNull(file, "file");
Args.check(file.exists() && file.canRead(),
"Provided file is either null, doesn't exist or is not readable!");
Args.check(file.length() <= 8<<20, //8MB, TODO: deal with Discord Nitro allowing 50MB files.
"File is to big! Max file-size is 8MB");
return sendFile(IOUtil.readFully(file), fileName, message);
}
/**
* Uploads a file to the Discord servers and sends it to this {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* Sends the provided {@link net.dv8tion.jda.core.entities.Message Message} with the uploaded file.
* <br>If you do not wish to send a Message with the uploaded file, you can provide {@code null} for
* the {@code message} parameter.
* <br>This allows you to send an {@link java.io.InputStream InputStream} as substitute to a file.
*
* <p>For information about the {@code fileName} parameter, Refer to the documentation for {@link #sendFile(java.io.File, String, Message)}.
* <br>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to the documentation for {@link #sendFile(java.io.File, String, Message)}.
*
* @param data
* The InputStream data to upload to the {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* @param fileName
* The name that should be sent to discord
* <br>Refer to the documentation for {@link #sendFile(java.io.File, String, Message)} for information about this parameter.
* @param message
* The message to be sent along with the uploaded file. This value can be {@code null}.
*
* @throws java.lang.IllegalArgumentException
* If the provided filename is {@code null} or {@code empty}.
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}</li>
* </ul>
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The {@link net.dv8tion.jda.core.entities.Message Message} created from this upload.
*/
default RestAction<Message> sendFile(InputStream data, String fileName, Message message)
{
Args.notNull(data, "data InputStream");
Args.notNull(fileName, "fileName");
Route.CompiledRoute route = Route.Messages.SEND_MESSAGE.compile(getId());
MultipartBody body = Unirest.post(Requester.DISCORD_API_PREFIX + route.getCompiledRoute())
.fields(null); //We use this to change from an HttpRequest to a MultipartBody
body.field("file", data, fileName);
if (message != null)
{
if (!message.getEmbeds().isEmpty())
{
AccountType type = getJDA().getAccountType();
MessageEmbed embed = message.getEmbeds().get(0);
Args.check(embed.isSendable(type),
"Provided Message contains an embed with a length greater than %d characters, which is the max for %s accounts!",
type == AccountType.BOT ? MessageEmbed.EMBED_MAX_LENGTH_BOT : MessageEmbed.EMBED_MAX_LENGTH_CLIENT, type);
}
body.field("payload_json", ((MessageImpl) message).toJSONObject().toString());
}
return new RestAction<Message>(getJDA(), route, body)
{
@Override
protected void handleResponse(Response response, Request<Message> request)
{
if (response.isOk())
request.onSuccess(api.getEntityBuilder().createMessage(response.getObject(), MessageChannel.this, false));
else
request.onFailure(response);
}
};
}
/**
* Uploads a file to the Discord servers and sends it to this {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* Sends the provided {@link net.dv8tion.jda.core.entities.Message Message} with the uploaded file.
* <br>If you do not wish to send a Message with the uploaded file, you can provide {@code null} for
* the {@code message} parameter.
* <br>This allows you to send an {@code byte[]} as substitute to a file.
*
* <p>For information about the {@code fileName} parameter, Refer to the documentation for {@link #sendFile(java.io.File, String, Message)}.
* <br>For {@link net.dv8tion.jda.core.requests.ErrorResponse} information, refer to the documentation for {@link #sendFile(java.io.File, String, Message)}.
*
* @param data
* The {@code byte[]} data to upload to the {@link net.dv8tion.jda.core.entities.MessageChannel MessageChannel}.
* @param fileName
* The name that should be sent to discord.
* <br>Refer to the documentation for {@link #sendFile(java.io.File, String, Message)} for information about this parameter.
* @param message
* The message to be sent along with the uploaded file. This value can be {@code null}.
*
* @throws java.lang.IllegalArgumentException
* <ul>
* <li>If the provided filename is {@code null} or {@code empty} or the provided data is larger than 8MB.</li>
* <li>If the provided {@link net.dv8tion.jda.core.entities.Message Message}
* contains an {@link net.dv8tion.jda.core.entities.MessageEmbed MessageEmbed}
* that is not {@link net.dv8tion.jda.core.entities.MessageEmbed#isSendable(net.dv8tion.jda.core.AccountType) sendable}</li>
* </ul>
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_WRITE Permission.MESSAGE_WRITE}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_ATTACH_FILES Permission.MESSAGE_ATTACH_FILES}</li>
* </ul>
* @throws java.lang.UnsupportedOperationException
* If this is a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel}
* and both the currently logged in account and the target user are bots.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.Message Message}
* <br>The {@link net.dv8tion.jda.core.entities.Message Message} created from this upload.
*/
default RestAction<Message> sendFile(byte[] data, String fileName, Message message)
{
Args.notNull(data, "file data[]");
Args.notNull(fileName, "fileName");
Args.check(data.length <= 8<<20, //8MB
"Provided data is too large! Max file-size is 8MB");
Route.CompiledRoute route = Route.Messages.SEND_MESSAGE.compile(getId());
MultipartBody body = Unirest.post(Requester.DISCORD_API_PREFIX + route.getCompiledRoute())
.fields(null); //We use this to change from an HttpRequest to a MultipartBody
body.field("file", data, fileName);
if (message != null)
{
if (!message.getEmbeds().isEmpty())
{
AccountType type = getJDA().getAccountType();
MessageEmbed embed = message.getEmbeds().get(0);
Args.check(embed.isSendable(type),
"Provided Message contains an embed with a length greater than %d characters, which is the max for %s accounts!",
type == AccountType.BOT ? MessageEmbed.EMBED_MAX_LENGTH_BOT : MessageEmbed.EMBED_MAX_LENGTH_CLIENT, type);
}
body.field("payload_json", ((MessageImpl) message).toJSONObject().toString());
}
return new RestAction<Message>(getJDA(), route, body)
{
@Override
protected void handleResponse(Response response, Request<Message> request)
{
if (response.isOk())
request.onSuccess(api.getEntityBuilder().createMessage(response.getObject(), MessageChannel.this, false));
else
request.onFailure(response);
}
};
}
/**
* Attempts to get a {@link net.dv8tion.jda.core.entities.Message Message} from the Discord's servers that has
* the same id as the id provided.
* <br>Note: when retrieving a Message, you must retrieve it from the channel it was sent in!
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The request was attempted after the account lost {@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY}
* in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_MESSAGE UNKNOWN_MESSAGE}
* <br>The provided {@code id} does not refer to a message sent in this channel or the message has already been deleted.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The request was attempted after the channel was deleted.</li>
* </ul>
*
* @param messageId
* The id of the sought after Message
*
* @throws IllegalArgumentException
* if the provided {@code messageId} is null or empty.
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY}</li>
* </ul>
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: Message
* <br>The Message defined by the provided id.
*/
default RestAction<Message> getMessageById(String messageId)
{
if (getJDA().getAccountType() != AccountType.BOT)
throw new AccountTypeException(AccountType.BOT);
Args.notEmpty(messageId, "Provided messageId");
Route.CompiledRoute route = Route.Messages.GET_MESSAGE.compile(getId(), messageId);
return new RestAction<Message>(getJDA(), route, null)
{
@Override
protected void handleResponse(Response response, Request<Message> request)
{
if (response.isOk())
{
Message m = api.getEntityBuilder().createMessage(response.getObject(), MessageChannel.this, false);
request.onSuccess(m);
}
else
request.onFailure(response);
}
};
}
/**
* Attempts to get a {@link net.dv8tion.jda.core.entities.Message Message} from the Discord's servers that has
* the same id as the id provided.
* <br>Note: when retrieving a Message, you must retrieve it from the channel it was sent in!
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The request was attempted after the account lost {@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY}
* in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_MESSAGE UNKNOWN_MESSAGE}
* <br>The provided {@code id} does not refer to a message sent in this channel or the message has already been deleted.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The request was attempted after the channel was deleted.</li>
* </ul>
*
* @param messageId
* The id of the sought after Message
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY}</li>
* </ul>
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: Message
* <br>The Message defined by the provided id.
*/
default RestAction<Message> getMessageById(long messageId)
{
return getMessageById(Long.toUnsignedString(messageId));
}
/**
* Attempts to delete a {@link net.dv8tion.jda.core.entities.Message Message} from the Discord servers that has
* the same id as the id provided.
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The request attempted to delete a Message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* that was not sent by the currently logged in account.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#INVALID_DM_ACTION INVALID_DM_ACTION}
* <br>Attempted to delete a Message in a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} or
* {@link net.dv8tion.jda.client.entities.Group Group} that was not sent by the currently logged in account.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_MESSAGE UNKNOWN_MESSAGE}
* <br>The provided {@code id} does not refer to a message sent in this channel or the message has already been deleted.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The request was attempted after the channel was deleted.</li>
* </ul>
*
* @param messageId
* The id of the Message that should be deleted
*
* @throws IllegalArgumentException
* if the provided messageId is null
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: Void
*/
default AuditableRestAction<Void> deleteMessageById(String messageId)
{
Args.notEmpty(messageId, "messageId");
Route.CompiledRoute route = Route.Messages.DELETE_MESSAGE.compile(getId(), messageId);
return new AuditableRestAction<Void>(getJDA(), route, null) {
@Override
protected void handleResponse(Response response, Request<Void> request)
{
if (response.isOk())
request.onSuccess(null);
else
request.onFailure(response);
}
};
}
/**
* Attempts to delete a {@link net.dv8tion.jda.core.entities.Message Message} from the Discord servers that has
* the same id as the id provided.
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The request attempted to delete a Message in a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* that was not sent by the currently logged in account.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#INVALID_DM_ACTION INVALID_DM_ACTION}
* <br>Attempted to delete a Message in a {@link net.dv8tion.jda.core.entities.PrivateChannel PrivateChannel} or
* {@link net.dv8tion.jda.client.entities.Group Group} that was not sent by the currently logged in account.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_MESSAGE UNKNOWN_MESSAGE}
* <br>The provided {@code id} does not refer to a message sent in this channel or the message has already been deleted.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The request was attempted after the channel was deleted.</li>
* </ul>
*
* @param messageId
* The id of the Message that should be deleted
*
* @throws IllegalArgumentException
* if the provided messageId is not positive
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}.
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: Void
*/
default AuditableRestAction<Void> deleteMessageById(long messageId)
{
return deleteMessageById(Long.toUnsignedString(messageId));
}
/**
* Creates a new {@link MessageHistory MessageHistory} object for each call of this method.
* <br>MessageHistory is <b>NOT</b> an internal message cache, but rather it queries the Discord servers for previously sent messages.
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* and the currently logged in account does not have the permission {@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY MESSAGE_HISTORY}
*
* @return A {@link net.dv8tion.jda.core.entities.MessageHistory MessageHistory} related to this channel.
*/
default MessageHistory getHistory()
{
return new MessageHistory(this);
}
/**
* A {@link net.dv8tion.jda.core.requests.restaction.pagination.PaginationAction PaginationAction} implementation
* that allows to {@link Iterable iterate} over recent {@link net.dv8tion.jda.core.entities.Message Messages} of
* this MessageChannel.
* <br>This is <b>not</b> a cache for received messages and it can only view messages that were sent
* before. This iterates chronologically backwards (from present to past).
*
* <p><b><u>It is recommended not to use this in an enhanced for-loop without end conditions as it might cause memory
* overflows in channels with a long message history.</u></b>
*
* <h1>Examples</h1>
* <pre><code>
* public boolean containsMessage(MessageChannel channel, String content, int checkAmount)
* {
* for (Message message : channel.<u>getIterableHistory()</u>)
* {
* if (message.getRawContent().equals(content))
* return true;
* if (checkAmount--{@literal <=} 0) break;
* }
* return false;
* }
*
* public List{@literal <Message>} getMessagesByUser(MessageChannel channel, User user)
* {
* return channel.<u>getIterableHistory()</u>.stream()
* .limit(1000)
* .filter(m{@literal ->} m.getAuthor().equals(user))
* .collect(Collectors.toList());
* }
* </code></pre>
*
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}
* and the currently logged in account does not have the permission {@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY MESSAGE_HISTORY}
*
* @return {@link net.dv8tion.jda.core.requests.restaction.pagination.MessagePaginationAction MessagePaginationAction}
*/
default MessagePaginationAction getIterableHistory()
{
return new MessagePaginationAction(this);
}
/**
* Uses the provided {@link net.dv8tion.jda.core.entities.Message Message} as a marker and retrieves messages around
* the marker. The {@code limit} determines the amount of message retrieved near the marker. Discord will
* attempt to evenly split the limit between before and after the marker, however in the case that the marker is set
* near the beginning or near the end of the channel's history the amount of messages on each side of the marker may
* be different, and their total count may not equal the provided {@code limit}.
*
* <p><b>Examples:</b>
* <br>Retrieve 100 messages from the middle of history. {@literal >}100 message exist in history and the marker is {@literal >}50 messages
* from the edge of history.
* <br>{@code getHistoryAround(message, 100)} - This will retrieve 100 messages from history, 50 before the marker
* and 50 after the marker.
*
* <p>Retrieve 10 messages near the end of history. Provided message is the 3rd most recent message.
* <br>{@code getHistoryAround(message, 10)} - This will retrieve 10 messages from history, 8 before the marker
* and 2 after the marker.
*
* <p>The following {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} are possible:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>The request was attempted after the account lost access to the
* {@link net.dv8tion.jda.core.entities.Guild Guild} or {@link net.dv8tion.jda.client.entities.Group Group}
* typically due to being kicked or removed, or after {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}
* was revoked in the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The request was attempted after the account lost
* {@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY} in the
* {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_MESSAGE UNKNOWN_MESSAGE}
* <br>The provided {@code message} has already been deleted, thus could not be used as a marker.</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#UNKNOWN_CHANNEL UNKNOWN_CHANNEL}
* <br>The request was attempted after the channel was deleted.</li>
* </ul>
*
* @param message
* The {@link net.dv8tion.jda.core.entities.Message Message} that will act as a marker. The provided Message
* must be from this MessageChannel.
* @param limit
* The amount of message to be retrieved around the marker. Minimum: 1, Max: 100.
*
* @throws java.lang.IllegalArgumentException
* <ul>
* <li>Provided {@code message} is {@code null}.</li>
* <li>Provided {@code message} is not from this MessageChannel.</li>
* <li>Provided {@code limit} is less than {@code 1} or greater than {@code 100}.</li>
* </ul>
* @throws net.dv8tion.jda.core.exceptions.PermissionException
* If this is a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} and the logged in account does not have
* <ul>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ}</li>
* <li>{@link net.dv8tion.jda.core.Permission#MESSAGE_HISTORY Permission.MESSAGE_HISTORY}</li>
* </ul>
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@link net.dv8tion.jda.core.entities.MessageHistory MessageHistory}
* <br>Provides a MessageHistory object with message around the provided message loaded into it.
*/
default RestAction<MessageHistory> getHistoryAround(Message message, int limit)
{
Args.notNull(message, "Provided target message");
Args.check(message.getChannel().equals(this), "The provided Message is not from the MessageChannel!");
return getHistoryAround(message.getId(), limit);
}
/**
* Uses the provided {@code id} of a message as a marker and retrieves messages around
* the marker. The {@code limit} determines the amount of message retrieved near the marker. Discord will
* attempt to evenly split the limit between before and after the marker, however in the case that the marker is set
* near the beginning or near the end of the channel's history the amount of messages on each side of the marker may
* be different, and their total count may not equal the provided {@code limit}.
*
* <p><b>Examples:</b>
* <br>Retrieve 100 messages from the middle of history. {@literal >}100 message exist in history and the marker is {@literal >}50 messages