/
Guild.java
5898 lines (5622 loc) · 265 KB
/
Guild.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 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.entities;
import net.dv8tion.jda.annotations.DeprecatedSince;
import net.dv8tion.jda.annotations.ForRemoval;
import net.dv8tion.jda.annotations.ReplaceWith;
import net.dv8tion.jda.api.JDA;
import net.dv8tion.jda.api.Permission;
import net.dv8tion.jda.api.Region;
import net.dv8tion.jda.api.entities.templates.Template;
import net.dv8tion.jda.api.exceptions.HierarchyException;
import net.dv8tion.jda.api.exceptions.InsufficientPermissionException;
import net.dv8tion.jda.api.interactions.commands.Command;
import net.dv8tion.jda.api.interactions.commands.build.CommandData;
import net.dv8tion.jda.api.interactions.commands.privileges.CommandPrivilege;
import net.dv8tion.jda.api.managers.AudioManager;
import net.dv8tion.jda.api.managers.GuildManager;
import net.dv8tion.jda.api.requests.GatewayIntent;
import net.dv8tion.jda.api.requests.RestAction;
import net.dv8tion.jda.api.requests.restaction.*;
import net.dv8tion.jda.api.requests.restaction.order.CategoryOrderAction;
import net.dv8tion.jda.api.requests.restaction.order.ChannelOrderAction;
import net.dv8tion.jda.api.requests.restaction.order.RoleOrderAction;
import net.dv8tion.jda.api.requests.restaction.pagination.AuditLogPaginationAction;
import net.dv8tion.jda.api.requests.restaction.pagination.PaginationAction;
import net.dv8tion.jda.api.utils.MiscUtil;
import net.dv8tion.jda.api.utils.cache.CacheFlag;
import net.dv8tion.jda.api.utils.cache.MemberCacheView;
import net.dv8tion.jda.api.utils.cache.SnowflakeCacheView;
import net.dv8tion.jda.api.utils.cache.SortedSnowflakeCacheView;
import net.dv8tion.jda.api.utils.concurrent.Task;
import net.dv8tion.jda.internal.requests.DeferredRestAction;
import net.dv8tion.jda.internal.requests.Route;
import net.dv8tion.jda.internal.requests.restaction.AuditableRestActionImpl;
import net.dv8tion.jda.internal.utils.Checks;
import net.dv8tion.jda.internal.utils.concurrent.task.GatewayTask;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.*;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.Future;
import java.util.function.Consumer;
import java.util.function.Predicate;
/**
* Represents a Discord {@link net.dv8tion.jda.api.entities.Guild Guild}.
* This should contain all information provided from Discord about a Guild.
*
* @see JDA#getGuildCache()
* @see JDA#getGuildById(long)
* @see JDA#getGuildsByName(String, boolean)
* @see JDA#getGuilds()
*/
public interface Guild extends ISnowflake
{
/** Template for {@link #getIconUrl()}. */
String ICON_URL = "https://cdn.discordapp.com/icons/%s/%s.%s";
/** Template for {@link #getSplashUrl()}. */
String SPLASH_URL = "https://cdn.discordapp.com/splashes/%s/%s.png";
/** Template for {@link #getBannerUrl()}. */
String BANNER_URL = "https://cdn.discordapp.com/banners/%s/%s.png";
/**
* Retrieves the list of guild commands.
* <br>This list does not include global commands! Use {@link JDA#retrieveCommands()} for global commands.
*
* @return {@link RestAction} - Type: {@link List} of {@link Command}
*/
@Nonnull
@CheckReturnValue
RestAction<List<Command>> retrieveCommands();
/**
* Retrieves the existing {@link Command} instance by id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The command id
*
* @throws IllegalArgumentException
* If the provided id is not a valid snowflake
*
* @return {@link RestAction} - Type: {@link Command}
*/
@Nonnull
@CheckReturnValue
RestAction<Command> retrieveCommandById(@Nonnull String id);
/**
* Retrieves the existing {@link Command} instance by id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The command id
*
* @return {@link RestAction} - Type: {@link Command}
*/
@Nonnull
@CheckReturnValue
default RestAction<Command> retrieveCommandById(long id)
{
return retrieveCommandById(Long.toUnsignedString(id));
}
/**
* Creates or updates a command.
* <br>If a command with the same name exists, it will be replaced.
*
* <p>To specify a complete list of all commands you can use {@link #updateCommands()} instead.
*
* <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
*
* @param command
* The {@link CommandData} for the command
*
* @throws IllegalArgumentException
* If null is provided
*
* @return {@link CommandCreateAction}
*/
@Nonnull
@CheckReturnValue
CommandCreateAction upsertCommand(@Nonnull CommandData command);
/**
* Creates or updates a command.
* <br>If a command with the same name exists, it will be replaced.
*
* <p>To specify a complete list of all commands you can use {@link #updateCommands()} instead.
*
* <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
*
* @param name
* The lowercase alphanumeric (with dash) name, 1-32 characters
* @param description
* The description for the command, 1-100 characters
*
* @throws IllegalArgumentException
* If null is provided or the name/description do not meet the requirements
*
* @return {@link CommandCreateAction}
*/
@Nonnull
@CheckReturnValue
default CommandCreateAction upsertCommand(@Nonnull String name, @Nonnull String description)
{
return upsertCommand(new CommandData(name, description));
}
/**
* Configures the complete list of guild commands.
* <br>This will replace the existing command list for this guild. You should only use this once on startup!
*
* <p>You need the OAuth2 scope {@code "applications.commands"} in order to add commands to a guild.
*
* <h2>Examples</h2>
* <pre>{@code
* // Set list to 2 commands
* guild.updateCommands()
* .addCommands(new CommandData("ping", "Gives the current ping"))
* .addCommands(new CommandData("ban", "Ban the target user")
* .addOption(OptionType.USER, "user", "The user to ban", true))
* .queue();
* // Delete all commands
* guild.updateCommands().queue();
* }</pre>
*
* @return {@link CommandListUpdateAction}
*/
@Nonnull
@CheckReturnValue
CommandListUpdateAction updateCommands();
/**
* Edit an existing command by id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command to edit
*
* @throws IllegalArgumentException
* If the provided id is not a valid snowflake
*
* @return {@link CommandEditAction} used to edit the command
*/
@Nonnull
@CheckReturnValue
CommandEditAction editCommandById(@Nonnull String id);
/**
* Edit an existing command by id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command to edit
*
* @return {@link CommandEditAction} used to edit the command
*/
@Nonnull
@CheckReturnValue
default CommandEditAction editCommandById(long id)
{
return editCommandById(Long.toUnsignedString(id));
}
/**
* Delete the command for this id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param commandId
* The id of the command that should be deleted
*
* @throws IllegalArgumentException
* If the provided id is not a valid snowflake
*
* @return {@link RestAction}
*/
@Nonnull
@CheckReturnValue
RestAction<Void> deleteCommandById(@Nonnull String commandId);
/**
* Delete the command for this id.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param commandId
* The id of the command that should be deleted
*
* @return {@link RestAction}
*/
@Nonnull
@CheckReturnValue
default RestAction<Void> deleteCommandById(long commandId)
{
return deleteCommandById(Long.toUnsignedString(commandId));
}
/**
* Retrieves the {@link CommandPrivilege CommandPrivileges} for the command with the specified ID.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param commandId
* The id of the command, this can be global or guild command
*
* @throws IllegalArgumentException
* If the id is not a valid snowflake
*
* @return {@link RestAction} - Type: {@link List} of {@link CommandPrivilege}
*/
@Nonnull
@CheckReturnValue
RestAction<List<CommandPrivilege>> retrieveCommandPrivilegesById(@Nonnull String commandId);
/**
* Retrieves the {@link CommandPrivilege CommandPrivileges} for the command with the specified ID.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param commandId
* The id of the command, this can be global or guild command
*
* @throws IllegalArgumentException
* If the id is not a valid snowflake
*
* @return {@link RestAction} - Type: {@link List} of {@link CommandPrivilege}
*/
@Nonnull
@CheckReturnValue
default RestAction<List<CommandPrivilege>> retrieveCommandPrivilegesById(long commandId)
{
return retrieveCommandPrivilegesById(Long.toUnsignedString(commandId));
}
/**
* Retrieves the {@link CommandPrivilege CommandPrivileges} for the commands in this guild.
* <br>The RestAction provides a {@link Map} from the command id to the list of privileges.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* @return {@link RestAction} - Type: {@link Map} from {@link String} Command ID to {@link List} of {@link CommandPrivilege}
*/
@Nonnull
@CheckReturnValue
RestAction<Map<String, List<CommandPrivilege>>> retrieveCommandPrivileges();
/**
* Updates the list of {@link CommandPrivilege CommandPrivileges} for the specified command.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command, this can be global or guild command
* @param privileges
* Complete list of up to 10 {@link CommandPrivilege CommandPrivileges} for this command
*
* @throws IllegalArgumentException
* If null is provided, the id is not a valid snowflake, or more than 10 privileges are provided
*
* @return {@link RestAction} - Type: {@link List} or {@link CommandPrivilege}
* The updated list of privileges for this command.
*/
@Nonnull
@CheckReturnValue
RestAction<List<CommandPrivilege>> updateCommandPrivilegesById(@Nonnull String id, @Nonnull Collection<? extends CommandPrivilege> privileges);
/**
* Updates the list of {@link CommandPrivilege CommandPrivileges} for the specified command.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command, this can be global or guild command
* @param privileges
* Complete list of up to 10 {@link CommandPrivilege CommandPrivileges} for this command
*
* @throws IllegalArgumentException
* If null is provided, the id is not a valid snowflake, or more than 10 privileges are provided
*
* @return {@link RestAction} - Type: {@link List} or {@link CommandPrivilege}
* The updated list of privileges for this command.
*/
@Nonnull
@CheckReturnValue
default RestAction<List<CommandPrivilege>> updateCommandPrivilegesById(@Nonnull String id, @Nonnull CommandPrivilege... privileges)
{
Checks.noneNull(privileges, "CommandPrivileges");
return updateCommandPrivilegesById(id, Arrays.asList(privileges));
}
/**
* Updates the list of {@link CommandPrivilege CommandPrivileges} for the specified command.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command, this can be global or guild command
* @param privileges
* Complete list of up to 10 {@link CommandPrivilege CommandPrivileges} for this command
*
* @throws IllegalArgumentException
* If null is provided or more than 10 privileges are provided
*
* @return {@link RestAction} - Type: {@link List} or {@link CommandPrivilege}
* The updated list of privileges for this command.
*/
@Nonnull
@CheckReturnValue
default RestAction<List<CommandPrivilege>> updateCommandPrivilegesById(long id, @Nonnull Collection<? extends CommandPrivilege> privileges)
{
return updateCommandPrivilegesById(Long.toUnsignedString(id), privileges);
}
/**
* Updates the list of {@link CommandPrivilege CommandPrivileges} for the specified command.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param id
* The id of the command, this can be global or guild command
* @param privileges
* Complete list of up to 10 {@link CommandPrivilege CommandPrivileges} for this command
*
* @throws IllegalArgumentException
* If null is provided or more than 10 privileges are provided
*
* @return {@link RestAction} - Type: {@link List} or {@link CommandPrivilege}
* The updated list of privileges for this command.
*/
@Nonnull
@CheckReturnValue
default RestAction<List<CommandPrivilege>> updateCommandPrivilegesById(long id, @Nonnull CommandPrivilege... privileges)
{
Checks.noneNull(privileges, "CommandPrivileges");
return updateCommandPrivilegesById(id, Arrays.asList(privileges));
}
/**
* Updates the list of {@link CommandPrivilege CommandPrivileges} for the specified commands.
* <br>The argument for this function is a {@link Map} similar to the one returned by {@link #retrieveCommandPrivileges()}.
*
* <p>These privileges are used to restrict who can use commands through Role/User whitelists/blacklists.
*
* <p>If there is no command with the provided ID,
* this RestAction fails with {@link net.dv8tion.jda.api.requests.ErrorResponse#UNKNOWN_COMMAND ErrorResponse.UNKNOWN_COMMAND}
*
* @param privileges
* Complete map of {@link CommandPrivilege CommandPrivileges} for each command
*
* @throws IllegalArgumentException
* If null is provided, any of the map keys is not a valid snowflake, or more than 10 privileges are provided for any command
*
* @return {@link RestAction} - Type: {@link Map} from {@link String} Command ID to {@link List} of {@link CommandPrivilege}
* The updated map of command privileges for this guild.
*/
@Nonnull
@CheckReturnValue
RestAction<Map<String, List<CommandPrivilege>>> updateCommandPrivileges(@Nonnull Map<String, Collection<? extends CommandPrivilege>> privileges);
/**
* Retrieves the available regions for this Guild
* <br>Shortcut for {@link #retrieveRegions(boolean) retrieveRegions(true)}
* <br>This will include deprecated voice regions by default.
*
* @return {@link net.dv8tion.jda.api.requests.RestAction RestAction} - Type {@link java.util.EnumSet EnumSet}
*/
@Nonnull
@CheckReturnValue
default RestAction<EnumSet<Region>> retrieveRegions()
{
return retrieveRegions(true);
}
/**
* Retrieves the available regions for this Guild
*
* @param includeDeprecated
* Whether to include deprecated regions
*
* @return {@link net.dv8tion.jda.api.requests.RestAction RestAction} - Type {@link java.util.EnumSet EnumSet}
*/
@Nonnull
@CheckReturnValue
RestAction<EnumSet<Region>> retrieveRegions(boolean includeDeprecated);
/**
* Adds the user represented by the provided id to this guild.
* <br>This requires an <b>OAuth2 Access Token</b> with the scope {@code guilds.join}.
*
* @param accessToken
* The access token
* @param userId
* The user id
*
* @throws IllegalArgumentException
* If the user id or access token is blank, empty, or null,
* or if the provided user is already in this guild
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link MemberAction MemberAction}
*
* @see <a href="https://discord.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@Nonnull
@CheckReturnValue
MemberAction addMember(@Nonnull String accessToken, @Nonnull String userId);
/**
* Adds the provided user to this guild.
* <br>This requires an <b>OAuth2 Access Token</b> with the scope {@code guilds.join}.
*
* @param accessToken
* The access token
* @param user
* The user
*
* @throws IllegalArgumentException
* If the user or access token is blank, empty, or null,
* or if the provided user is already in this guild
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link MemberAction MemberAction}
*
* @see <a href="https://discord.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@Nonnull
@CheckReturnValue
default MemberAction addMember(@Nonnull String accessToken, @Nonnull User user)
{
Checks.notNull(user, "User");
return addMember(accessToken, user.getId());
}
/**
* Adds the user represented by the provided id to this guild.
* <br>This requires an <b>OAuth2 Access Token</b> with the scope {@code guilds.join}.
*
* @param accessToken
* The access token
* @param userId
* The user id
*
* @throws IllegalArgumentException
* If the user id or access token is blank, empty, or null,
* or if the provided user is already in this guild
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.api.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link MemberAction MemberAction}
*
* @see <a href="https://discord.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@Nonnull
@CheckReturnValue
default MemberAction addMember(@Nonnull String accessToken, long userId)
{
return addMember(accessToken, Long.toUnsignedString(userId));
}
/**
* Whether this guild has loaded members.
* <br>This will always be false if the {@link GatewayIntent#GUILD_MEMBERS GUILD_MEMBERS} intent is disabled.
*
* @return True, if members are loaded.
*/
boolean isLoaded();
/**
* Re-apply the {@link net.dv8tion.jda.api.utils.MemberCachePolicy MemberCachePolicy} of this session to all {@link Member Members} of this Guild.
*
* <h2>Example</h2>
* <pre>{@code
* // Check if the members of this guild have at least 50% bots (bot collection/farm)
* public void checkBots(Guild guild) {
* // Keep in mind: This requires the GUILD_MEMBERS intent which is disabled in createDefault and createLight by default
* guild.retrieveMembers() // Load members CompletableFuture<Void> (async and eager)
* .thenApply((v) -> guild.getMemberCache()) // Turn into CompletableFuture<MemberCacheView>
* .thenAccept((members) -> {
* int total = members.size();
* // Casting to double to get a double as result of division, don't need to worry about precision with small counts like this
* double bots = (double) members.applyStream(stream ->
* stream.map(Member::getUser)
* .filter(User::isBot)
* .count()); // Count bots
* if (bots / total > 0.5) // Check how many members are bots
* System.out.println("More than 50% of members in this guild are bots");
* })
* .thenRun(guild::pruneMemberCache); // Then prune the cache
* }
* }</pre>
*
* @see #unloadMember(long)
* @see JDA#unloadUser(long)
*/
void pruneMemberCache();
/**
* Attempts to remove the user with the provided id from the member cache.
* <br>If you attempt to remove the {@link JDA#getSelfUser() SelfUser} this will simply return {@code false}.
*
* <p>This should be used by an implementation of {@link net.dv8tion.jda.api.utils.MemberCachePolicy MemberCachePolicy}
* as an upstream request to remove a member. For example a Least-Recently-Used (LRU) cache might use this to drop
* old members if the cache capacity is reached. Or a timeout cache could use this to remove expired members.
*
* @param userId
* The target user id
*
* @return True, if the cache was changed
*
* @see #pruneMemberCache()
* @see JDA#unloadUser(long)
*/
boolean unloadMember(long userId);
/**
* The expected member count for this guild.
* <br>If this guild is not lazy loaded this should be identical to the size returned by {@link #getMemberCache()}.
*
* <p>When {@link net.dv8tion.jda.api.requests.GatewayIntent#GUILD_MEMBERS GatewayIntent.GUILD_MEMBERS} is disabled, this will not be updated.
*
* @return The expected member count for this guild
*/
int getMemberCount();
/**
* The human readable name of the {@link net.dv8tion.jda.api.entities.Guild Guild}.
* <p>
* This value can be modified using {@link GuildManager#setName(String)}.
*
* @return Never-null String containing the Guild's name.
*/
@Nonnull
String getName();
/**
* The Discord hash-id of the {@link net.dv8tion.jda.api.entities.Guild Guild} icon image.
* If no icon has been set, this returns {@code null}.
* <p>
* The Guild icon can be modified using {@link GuildManager#setIcon(Icon)}.
*
* @return Possibly-null String containing the Guild's icon hash-id.
*/
@Nullable
String getIconId();
/**
* The URL of the {@link net.dv8tion.jda.api.entities.Guild Guild} icon image.
* If no icon has been set, this returns {@code null}.
* <p>
* The Guild icon can be modified using {@link GuildManager#setIcon(Icon)}.
*
* @return Possibly-null String containing the Guild's icon URL.
*/
@Nullable
default String getIconUrl()
{
String iconId = getIconId();
return iconId == null ? null : String.format(ICON_URL, getId(), iconId, iconId.startsWith("a_") ? "gif" : "png");
}
/**
* The Features of the {@link net.dv8tion.jda.api.entities.Guild Guild}.
* <p>
* <a target="_blank" href="https://discord.com/developers/docs/resources/guild#guild-object-guild-features"><b>List of Features</b></a>
*
*
* @return Never-null, unmodifiable Set containing all of the Guild's features.
*/
@Nonnull
Set<String> getFeatures();
/**
* The Discord hash-id of the splash image for this Guild. A Splash image is an image displayed when viewing a
* Discord Guild Invite on the web or in client just before accepting or declining the invite.
* If no splash has been set, this returns {@code null}.
* <br>Splash images are VIP/Partner Guild only.
* <p>
* The Guild splash can be modified using {@link GuildManager#setSplash(Icon)}.
*
* @return Possibly-null String containing the Guild's splash hash-id
*/
@Nullable
String getSplashId();
/**
* The URL of the splash image for this Guild. A Splash image is an image displayed when viewing a
* Discord Guild Invite on the web or in client just before accepting or declining the invite.
* If no splash has been set, this returns {@code null}.
* <br>Splash images are VIP/Partner Guild only.
* <p>
* The Guild splash can be modified using {@link GuildManager#setSplash(Icon)}.
*
* @return Possibly-null String containing the Guild's splash URL.
*/
@Nullable
default String getSplashUrl()
{
String splashId = getSplashId();
return splashId == null ? null : String.format(SPLASH_URL, getId(), splashId);
}
/**
* Gets the vanity url for this Guild. The vanity url is the custom invite code of partnered / official Guilds.
* The returned String will be the code that can be provided to {@code discord.gg/{code}} to get the invite link.
* <br>You can check {@link #getFeatures()} to see if this Guild has a vanity url
* <p>
* This action requires the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
* <p>
* Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
* <ul>
* <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#INVITE_CODE_INVALID INVITE_CODE_INVALID}
* <br>If this guild does not have a vanity invite</li>
*
* <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The vanity url cannot be fetched due to a permission discrepancy</li>
* </ul>
*
* @throws net.dv8tion.jda.api.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
* @throws java.lang.IllegalStateException
* If the guild doesn't have the VANITY_URL feature
*
* @return {@link net.dv8tion.jda.api.requests.RestAction RestAction} - Type: String
* <br>The vanity url of this server
*
* @see #getFeatures()
* @see #getVanityCode()
*/
@Nonnull
@Deprecated
@ForRemoval(deadline = "4.4.0")
@DeprecatedSince("4.0.0")
@ReplaceWith("getVanityCode()")
@CheckReturnValue
RestAction<String> retrieveVanityUrl();
/**
* The vanity url code for this Guild. The vanity url is the custom invite code of partnered / official / boosted Guilds.
* <br>The returned String will be the code that can be provided to {@code discord.gg/{code}} to get the invite link.
*
* <p>The Vanity Code can be modified using {@link GuildManager#setVanityCode(String)}.
*
* @return The vanity code or null
*
* @since 4.0.0
*
* @see #getVanityUrl()
*/
@Nullable
String getVanityCode();
/**
* The vanity url for this Guild. The vanity url is the custom invite code of partnered / official / boosted Guilds.
* <br>The returned String will be the vanity invite link to this guild.
*
* <p>The Vanity Code can be modified using {@link GuildManager#setVanityCode(String)}.
*
* @return The vanity url or null
*
* @since 4.0.0
*/
@Nullable
default String getVanityUrl()
{
return getVanityCode() == null ? null : "https://discord.gg/" + getVanityCode();
}
/**
* Retrieves the Vanity Invite meta data for this guild.
* <br>This allows you to inspect how many times the vanity invite has been used.
* You can use {@link #getVanityUrl()} if you only care about the invite.
*
* <p>This action requires the {@link net.dv8tion.jda.api.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
*
* <p>Possible {@link net.dv8tion.jda.api.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.api.requests.RestAction RestAction} include the following:
* <ul>
* <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#INVITE_CODE_INVALID INVITE_CODE_INVALID}
* <br>If this guild does not have a vanity invite</li>
*
* <li>{@link net.dv8tion.jda.api.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The vanity invite cannot be fetched due to a permission discrepancy</li>
* </ul>
*
* @throws InsufficientPermissionException
* If the currently logged in account does not have {@link Permission#MANAGE_SERVER Permission.MANAGE_SERVER}
*
* @return {@link RestAction} - Type: {@link VanityInvite}
*
* @since 4.2.1
*/
@Nonnull
@CheckReturnValue
RestAction<VanityInvite> retrieveVanityInvite();
/**
* The description for this guild.
* <br>This is displayed in the server browser below the guild name for verified guilds.
*
* <p>The description can be modified using {@link GuildManager#setDescription(String)}.
*
* @return The description
*
* @since 4.0.0
*/
@Nullable
String getDescription();
/**
* The preferred locale for this guild.
* <br>If the guild doesn't have the COMMUNITY feature, this returns the default.
*
* <br>Default: {@link Locale#US}
*
* @return The preferred {@link Locale} for this guild
*
* @since 4.2.1
*/
@Nonnull
Locale getLocale();
/**
* The guild banner id.
* <br>This is shown in guilds below the guild name.
*
* <p>The banner can be modified using {@link GuildManager#setBanner(Icon)}.
*
* @return The guild banner id or null
*
* @since 4.0.0
*
* @see #getBannerUrl()
*/
@Nullable
String getBannerId();
/**
* The guild banner url.
* <br>This is shown in guilds below the guild name.
*
* <p>The banner can be modified using {@link GuildManager#setBanner(Icon)}.
*
* @return The guild banner url or null
*
* @since 4.0.0
*/
@Nullable
default String getBannerUrl()
{
String bannerId = getBannerId();
return bannerId == null ? null : String.format(BANNER_URL, getId(), bannerId);
}
/**
* The boost tier for this guild.
* <br>Each tier unlocks new perks for a guild that can be seen in the {@link #getFeatures() features}.
*
* @return The boost tier.
*
* @since 4.0.0
*/
@Nonnull
BoostTier getBoostTier();
/**
* The amount of boosts this server currently has.
*
* @return The boost count
*
* @since 4.0.0
*/
int getBoostCount();
/**
* Sorted list of {@link net.dv8tion.jda.api.entities.Member Members} that boost this guild.
* <br>The list is sorted by {@link net.dv8tion.jda.api.entities.Member#getTimeBoosted()} ascending.
* This means the first element will be the member who has been boosting for the longest time.
*
* @return Possibly-immutable list of members who boost this guild
*/
@Nonnull
List<Member> getBoosters();
/**
* The maximum bitrate that can be applied to a voice channel in this guild.
* <br>This depends on the features of this guild that can be unlocked for partners or through boosting.
*
* @return The maximum bitrate
*
* @since 4.0.0
*/
default int getMaxBitrate()
{
int maxBitrate = getFeatures().contains("VIP_REGIONS") ? 384000 : 96000;
return Math.max(maxBitrate, getBoostTier().getMaxBitrate());
}
/**
* Returns the maximum size for files that can be uploaded to this Guild.
* This returns 8 MiB for Guilds without a Boost Tier or Guilds with Boost Tier 1, 50 MiB for Guilds with Boost Tier 2 and 100 MiB for Guilds with Boost Tier 3.
*
* @return The maximum size for files that can be uploaded to this Guild
*
* @since 4.2.0
*/
default long getMaxFileSize()
{
return getBoostTier().getMaxFileSize();
}
/**
* The maximum amount of emotes a guild can have based on the guilds boost tier.
*
* @return The maximum amount of emotes
*
* @since 4.0.0
*/
default int getMaxEmotes()
{
int maxEmotes = getFeatures().contains("MORE_EMOJI") ? 200 : 50;
return Math.max(maxEmotes, getBoostTier().getMaxEmotes());
}
/**
* The maximum amount of members that can join this guild.
*
* @return The maximum amount of members
*
* @since 4.0.0
*
* @see #retrieveMetaData()
*/
int getMaxMembers();
/**
* The maximum amount of connected members this guild can have at a time.
* <br>This includes members that are invisible but still connected to discord.
* If too many members are online the guild will become unavailable for others.
*
* @return The maximum amount of connected members this guild can have
*
* @since 4.0.0
*
* @see #retrieveMetaData()
*/
int getMaxPresences();
/**
* Loads {@link MetaData} for this guild instance.
*
* @return {@link RestAction} - Type: {@link MetaData}
*
* @since 4.2.0
*/
@Nonnull
@CheckReturnValue
RestAction<MetaData> retrieveMetaData();
/**
* Provides the {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannel} that has been set as the channel
* which {@link net.dv8tion.jda.api.entities.Member Members} will be moved to after they have been inactive in a
* {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannel} for longer than {@link #getAfkTimeout()}.
* <br>If no channel has been set as the AFK channel, this returns {@code null}.
* <p>
* This value can be modified using {@link GuildManager#setAfkChannel(VoiceChannel)}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.VoiceChannel VoiceChannel} that is the AFK Channel.
*/
@Nullable
VoiceChannel getAfkChannel();
/**
* Provides the {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that has been set as the channel
* which newly joined {@link net.dv8tion.jda.api.entities.Member Members} will be announced in.
* <br>If no channel has been set as the system channel, this returns {@code null}.
* <p>
* This value can be modified using {@link GuildManager#setSystemChannel(TextChannel)}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that is the system Channel.
*/
@Nullable
TextChannel getSystemChannel();
/**
* Provides the {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that lists the rules of the guild.
* <br>If this guild doesn't have the COMMUNITY {@link #getFeatures() feature}, this returns {@code null}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that is the rules channel
*
* @see #getFeatures()
*/
@Nullable
TextChannel getRulesChannel();
/**
* Provides the {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that receives community updates.
* <br>If this guild doesn't have the COMMUNITY {@link #getFeatures() feature}, this returns {@code null}.
*
* @return Possibly-null {@link net.dv8tion.jda.api.entities.TextChannel TextChannel} that is the community updates channel
*
* @see #getFeatures()
*/
@Nullable
TextChannel getCommunityUpdatesChannel();