-
-
Notifications
You must be signed in to change notification settings - Fork 724
/
Guild.java
1505 lines (1394 loc) · 64.9 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-2018 Austin Keener & Michael Ritter & Florian Spieß
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package net.dv8tion.jda.core.entities;
import net.dv8tion.jda.client.requests.restaction.pagination.MentionPaginationAction;
import net.dv8tion.jda.core.JDA;
import net.dv8tion.jda.core.Region;
import net.dv8tion.jda.core.managers.AudioManager;
import net.dv8tion.jda.core.managers.GuildController;
import net.dv8tion.jda.core.managers.GuildManager;
import net.dv8tion.jda.core.managers.GuildManagerUpdatable;
import net.dv8tion.jda.core.requests.RestAction;
import net.dv8tion.jda.core.requests.restaction.MemberAction;
import net.dv8tion.jda.core.requests.restaction.pagination.AuditLogPaginationAction;
import net.dv8tion.jda.core.utils.Checks;
import net.dv8tion.jda.core.utils.cache.MemberCacheView;
import net.dv8tion.jda.core.utils.cache.SnowflakeCacheView;
import javax.annotation.CheckReturnValue;
import javax.annotation.Nonnull;
import javax.annotation.Nullable;
import java.util.Collection;
import java.util.EnumSet;
import java.util.List;
import java.util.Set;
/**
* Represents a Discord {@link net.dv8tion.jda.core.entities.Guild Guild}.
* This should contain all information provided from Discord about a Guild.
*/
public interface Guild extends ISnowflake
{
/**
* Retrieves the available regions for this Guild
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type {@link java.util.EnumSet EnumSet}
*/
@CheckReturnValue
RestAction<EnumSet<Region>> retrieveRegions();
/**
* 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.core.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.core.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link net.dv8tion.jda.core.requests.restaction.MemberAction MemberAction}
*
* @see <a href="https://discordapp.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@CheckReturnValue
MemberAction addMember(String accessToken, 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.core.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.core.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link net.dv8tion.jda.core.requests.restaction.MemberAction MemberAction}
*
* @see <a href="https://discordapp.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@CheckReturnValue
default MemberAction addMember(String accessToken, 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.core.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.core.Permission#CREATE_INSTANT_INVITE Permission.CREATE_INSTANT_INVITE}
*
* @return {@link net.dv8tion.jda.core.requests.restaction.MemberAction MemberAction}
*
* @see <a href="https://discordapp.com/developers/docs/topics/oauth2" target="_blank">Discord OAuth2 Documentation</a>
*
* @since 3.7.0
*/
@CheckReturnValue
default MemberAction addMember(String accessToken, long userId)
{
return addMember(accessToken, Long.toUnsignedString(userId));
}
/**
* The human readable name of the {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <p>
* This value can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setName(String)}.
*
* @return Never-null String containing the Guild's name.
*/
String getName();
/**
* The Discord hash-id of the {@link net.dv8tion.jda.core.entities.Guild Guild} icon image.
* If no icon has been set, this returns {@code null}.
* <p>
* The Guild icon can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setIcon(Icon)}.
*
* @return Possibly-null String containing the Guild's icon hash-id.
*/
String getIconId();
/**
* The URL of the {@link net.dv8tion.jda.core.entities.Guild Guild} icon image.
* If no icon has been set, this returns {@code null}.
* <p>
* The Guild icon can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setIcon(Icon)}.
*
* @return Possibly-null String containing the Guild's icon URL.
*/
String getIconUrl();
/**
* The Features of the {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <p>
* <b>Possible known features:</b>
* <ul>
* <li>VIP_REGIONS - Guild has VIP voice regions</li>
* <li>VANITY_URL - Guild a vanity URL (custom invite link). See {@link #getVanityUrl()}</li>
* <li>INVITE_SPLASH - Guild has custom invite splash. See {@link #getSplashId()} and {@link #getSplashUrl()}</li>
* <li>VERIFIED - Guild is "verified"</li>
* <li>MORE_EMOJI - Guild is able to use more than 50 emoji</li>
* </ul>
*
* @return Never-null, unmodifiable Set containing all of the Guild's features.
*/
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 net.dv8tion.jda.core.managers.GuildManager#setSplash(Icon)}.
*
* @return Possibly-null String containing the Guild's splash hash-id
*/
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 net.dv8tion.jda.core.managers.GuildManager#setSplash(Icon)}.
*
* @return Possibly-null String containing the Guild's splash URL.
*/
String getSplashUrl();
/**
* 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.core.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
* <p>
* Possible {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.core.requests.RestAction RestAction} include the following:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The ban list cannot be fetched due to a permission discrepancy</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>We were removed from the Guild before finishing the task</li>
* </ul>
*
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.core.Permission#MANAGE_SERVER MANAGE_SERVER} permission.
* @throws java.lang.IllegalStateException
* If the guild doesn't have the VANITY_URL feature
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* If the guild is temporarily not {@link #isAvailable() available}
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: String
* <br>The vanity url of this server
*
* @see #getFeatures()
*/
@CheckReturnValue
RestAction<String> getVanityUrl();
/**
* Provides the {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} that has been set as the channel
* which {@link net.dv8tion.jda.core.entities.Member Members} will be moved to after they have been inactive in a
* {@link net.dv8tion.jda.core.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 net.dv8tion.jda.core.managers.GuildManager#setAfkChannel(VoiceChannel)}.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} that is the AFK Channel.
*/
VoiceChannel getAfkChannel();
/**
* Provides the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} that has been set as the channel
* which newly joined {@link net.dv8tion.jda.core.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 net.dv8tion.jda.core.managers.GuildManager#setSystemChannel(TextChannel)}.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} that is the system Channel.
*/
TextChannel getSystemChannel();
/**
* The {@link net.dv8tion.jda.core.entities.Member Member} object of the owner of this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <p>
* Ownership can be transferred using {@link GuildController#transferOwnership(Member)}.
*
* @return Never-null Member object containing the Guild owner.
*/
Member getOwner();
/**
* The {@link net.dv8tion.jda.core.entities.Guild.Timeout Timeout} set for this Guild representing the amount of time
* that must pass for a Member to have had no activity in a {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel}
* to be considered AFK. If {@link #getAfkChannel()} is not {@code null} (thus an AFK channel has been set) then Member
* will be automatically moved to the AFK channel after they have been inactive for longer than the returned Timeout.
* <br>Default is {@link Timeout#SECONDS_300 300 seconds (5 minutes)}.
* <p>
* This value can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setAfkTimeout(net.dv8tion.jda.core.entities.Guild.Timeout)}.
*
* @return The {@link net.dv8tion.jda.core.entities.Guild.Timeout Timeout} set for this Guild.
*/
Timeout getAfkTimeout();
/**
* The Voice {@link net.dv8tion.jda.core.Region Region} that this Guild is
* using for audio connections.
* <br>If the Region is not recognized, returns {@link net.dv8tion.jda.core.Region#UNKNOWN UNKNOWN} but you
* can still use the {@link #getRegionRaw()} to retrieve the raw name this region has.
*
* <p>This value can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setRegion(net.dv8tion.jda.core.Region)}.
*
* @return The the audio Region this Guild is using for audio connections. Can return Region.UNKNOWN.
*/
default Region getRegion()
{
return Region.fromKey(getRegionRaw());
}
/**
* The raw voice region name that this Guild is using
* for audio connections.
* <br>This is resolved to an enum constant of {@link net.dv8tion.jda.core.Region Region} by {@link #getRegion()}!
*
* <p>This value can be modified using {@link net.dv8tion.jda.core.managers.GuildManager#setRegion(net.dv8tion.jda.core.Region)}.
*
* @return Raw region name
*/
String getRegionRaw();
/**
* Used to determine if the provided {@link net.dv8tion.jda.core.entities.User User} is a member of this Guild.
*
* @param user
* The user to determine whether or not they are a member of this guild.
*
* @return True - if this user is present in this guild.
*/
boolean isMember(User user);
/**
* Gets the {@link net.dv8tion.jda.core.entities.Member Member} object of the currently logged in account in this guild.
* <br>This is basically {@link net.dv8tion.jda.core.JDA#getSelfUser()} being provided to {@link #getMember(User)}.
*
* @return The Member object of the currently logged in account.
*/
Member getSelfMember();
/**
* Gets the Guild specific {@link net.dv8tion.jda.core.entities.Member Member} object for the provided
* {@link net.dv8tion.jda.core.entities.User User}.
* <br>If the user is not in this guild, {@code null} is returned.
*
* @param user
* The {@link net.dv8tion.jda.core.entities.User User} which to retrieve a related Member object for.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Member Member} for the related {@link net.dv8tion.jda.core.entities.User User}.
*/
Member getMember(User user);
/**
* Gets a {@link net.dv8tion.jda.core.entities.Member Member} object via the id of the user. The id relates to
* {@link net.dv8tion.jda.core.entities.User#getId()}, and this method is similar to {@link JDA#getUserById(String)}
* <br>This is more efficient that using {@link JDA#getUserById(String)} and {@link #getMember(User)}.
* <br>If no Member in this Guild has the {@code userId} provided, this returns {@code null}.
*
* @param userId
* The Discord id of the User for which a Member object is requested.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Member Member} with the related {@code userId}.
*/
default Member getMemberById(String userId)
{
return getMemberCache().getElementById(userId);
}
/**
* Gets a {@link net.dv8tion.jda.core.entities.Member Member} object via the id of the user. The id relates to
* {@link net.dv8tion.jda.core.entities.User#getIdLong()}, and this method is similar to {@link JDA#getUserById(long)}
* <br>This is more efficient that using {@link JDA#getUserById(long)} and {@link #getMember(User)}.
* <br>If no Member in this Guild has the {@code userId} provided, this returns {@code null}.
*
* @param userId
* The Discord id of the User for which a Member object is requested.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Member Member} with the related {@code userId}.
*/
default Member getMemberById(long userId)
{
return getMemberCache().getElementById(userId);
}
/**
* A list of all {@link net.dv8tion.jda.core.entities.Member Members} in this Guild.
* <br>The Members are not provided in any particular order.
*
* @return Immutable list of all members in this Guild.
*/
default List<Member> getMembers()
{
return getMemberCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Member Members} who have the same name as the one provided.
* <br>This compares against {@link net.dv8tion.jda.core.entities.Member#getUser()}{@link net.dv8tion.jda.core.entities.User#getName() .getName()}
* <br>If there are no {@link net.dv8tion.jda.core.entities.Member Members} with the provided name, then this returns an empty list.
*
* @param name
* The name used to filter the returned Members.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all Members with the same name as the name provided.
*/
default List<Member> getMembersByName(String name, boolean ignoreCase)
{
return getMemberCache().getElementsByUsername(name, ignoreCase);
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Member Members} who have the same nickname as the one provided.
* <br>This compares against {@link Member#getNickname()}. If a Member does not have a nickname, the comparison results as false.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Member Members} with the provided name, then this returns an empty list.
*
* @param nickname
* The nickname used to filter the returned Members.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all Members with the same nickname as the nickname provided.
*/
default List<Member> getMembersByNickname(String nickname, boolean ignoreCase)
{
return getMemberCache().getElementsByNickname(nickname, ignoreCase);
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Member Members} who have the same effective name as the one provided.
* <br>This compares against {@link net.dv8tion.jda.core.entities.Member#getEffectiveName()}}.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Member Members} with the provided name, then this returns an empty list.
*
*
* @param name
* The name used to filter the returned Members.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all Members with the same effective name as the name provided.
*/
default List<Member> getMembersByEffectiveName(String name, boolean ignoreCase)
{
return getMemberCache().getElementsByName(name, ignoreCase);
}
/**
* Gets a list of {@link net.dv8tion.jda.core.entities.Member Members} that have all
* {@link net.dv8tion.jda.core.entities.Role Roles} provided.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Member Members} with all provided roles, then this returns an empty list.
*
* @param roles
* The {@link net.dv8tion.jda.core.entities.Role Roles} that a {@link net.dv8tion.jda.core.entities.Member Member}
* must have to be included in the returned list.
*
* @throws java.lang.IllegalArgumentException
* If a provided {@link net.dv8tion.jda.core.entities.Role Role} is from a different guild or null.
*
* @return Possibly-empty immutable list of Members with all provided Roles.
*/
default List<Member> getMembersWithRoles(Role... roles)
{
return getMemberCache().getElementsWithRoles(roles);
}
/**
* Gets a list of {@link net.dv8tion.jda.core.entities.Member Members} that have all provided
* {@link net.dv8tion.jda.core.entities.Role Roles}.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Member Members} with all provided roles, then this returns an empty list.
*
* @param roles
* The {@link net.dv8tion.jda.core.entities.Role Roles} that a {@link net.dv8tion.jda.core.entities.Member Member}
* must have to be included in the returned list.
*
* @throws java.lang.IllegalArgumentException
* If a provided {@link net.dv8tion.jda.core.entities.Role Role} is from a different guild or null.
*
* @return Possibly-empty immutable list of Members with all provided Roles.
*/
default List<Member> getMembersWithRoles(Collection<Role> roles)
{
return getMemberCache().getElementsWithRoles(roles);
}
/**
* {@link net.dv8tion.jda.core.utils.cache.MemberCacheView MemberCacheView} for all cached
* {@link net.dv8tion.jda.core.entities.Member Members} of this Guild.
*
* @return {@link net.dv8tion.jda.core.utils.cache.MemberCacheView MemberCacheView}
*/
MemberCacheView getMemberCache();
/**
* Gets the {@link net.dv8tion.jda.core.entities.Category Category} from this guild that matches the provided id.
* This method is similar to {@link net.dv8tion.jda.core.JDA#getCategoryById(String)}, but it only checks in this
* specific Guild. <br>If there is no matching {@link net.dv8tion.jda.core.entities.Category Category} this returns
* {@code null}.
*
* @param id
* The snowflake ID of the wanted Category
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Category Category} for the provided ID.
* @throws java.lang.IllegalArgumentException
* If the provided ID is not a valid {@code long}
*/
default Category getCategoryById(String id)
{
return getCategoryCache().getElementById(id);
}
/**
* Gets the {@link net.dv8tion.jda.core.entities.Category Category} from this guild that matches the provided id.
* This method is similar to {@link net.dv8tion.jda.core.JDA#getCategoryById(String)}, but it only checks in this
* specific Guild. <br>If there is no matching {@link net.dv8tion.jda.core.entities.Category Category} this returns
* {@code null}.
*
* @param id
* The snowflake ID of the wanted Category
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Category Category} for the provided ID.
*/
default Category getCategoryById(long id)
{
return getCategoryCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.core.entities.Category Categories} in this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>The returned categories will be sorted according to their position.
*
* @return An immutable list of all {@link net.dv8tion.jda.core.entities.Category Categories} in this Guild.
*/
default List<Category> getCategories()
{
return getCategoryCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Category Categories} in this Guild that have the same
* name as the one provided. <br>If there are no matching categories this will return an empty list.
*
* @param name
* The name to check
* @param ignoreCase
* Whether to ignore case on name checking
* @return Immutable list of all categories matching the provided name
* @throws java.lang.IllegalArgumentException
* If the provided name is {@code null}
*/
default List<Category> getCategoriesByName(String name, boolean ignoreCase)
{
return getCategoryCache().getElementsByName(name, ignoreCase);
}
/**
* Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView} of
* all cached {@link net.dv8tion.jda.core.entities.Category Categories} of this Guild.
* <br>Categories are sorted according to their position.
*
* @return Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
SnowflakeCacheView<Category> getCategoryCache();
/**
* Gets a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} from this guild that has the same id as the
* one provided. This method is similar to {@link net.dv8tion.jda.core.JDA#getTextChannelById(String)}, but it only
* checks this specific Guild for a TextChannel.
* <br>If there is no {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} with matching id.
*/
default TextChannel getTextChannelById(String id)
{
return getTextChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} from this guild that has the same id as the
* one provided. This method is similar to {@link net.dv8tion.jda.core.JDA#getTextChannelById(long)}, but it only
* checks this specific Guild for a TextChannel.
* <br>If there is no {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} with matching id.
*/
default TextChannel getTextChannelById(long id)
{
return getTextChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.core.entities.TextChannel TextChannels} in this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>The channels returned will be sorted according to their position.
*
* @return An immutable List of all {@link net.dv8tion.jda.core.entities.TextChannel TextChannels} in this Guild.
*/
default List<TextChannel> getTextChannels()
{
return getTextChannelCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.TextChannel TextChannels} in this Guild that have the same
* name as the one provided.
* <br>If there are no {@link net.dv8tion.jda.core.entities.TextChannel TextChannels} with the provided name, then this returns an empty list.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.core.entities.TextChannel TextChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all TextChannels names that match the provided name.
*/
default List<TextChannel> getTextChannelsByName(String name, boolean ignoreCase)
{
return getTextChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView} of
* all cached {@link net.dv8tion.jda.core.entities.TextChannel TextChannels} of this Guild.
* <br>TextChannels are sorted according to their position.
*
* @return Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
SnowflakeCacheView<TextChannel> getTextChannelCache();
/**
* Gets a {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} from this guild that has the same id as the
* one provided. This method is similar to {@link net.dv8tion.jda.core.JDA#getVoiceChannelById(String)}, but it only
* checks this specific Guild for a VoiceChannel.
* <br>If there is no {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} with matching id.
*/
default VoiceChannel getVoiceChannelById(String id)
{
return getVoiceChannelCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} from this guild that has the same id as the
* one provided. This method is similar to {@link net.dv8tion.jda.core.JDA#getVoiceChannelById(long)}, but it only
* checks this specific Guild for a VoiceChannel.
* <br>If there is no {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel}.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannel} with matching id.
*/
default VoiceChannel getVoiceChannelById(long id)
{
return getVoiceChannelCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels} in this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>The channels returned will be sorted according to their position.
*
* @return An immutable List of {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels}.
*/
default List<VoiceChannel> getVoiceChannels()
{
return getVoiceChannelCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels} in this Guild that have the same
* name as the one provided.
* <br>If there are no {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels} with the provided name, then this returns an empty list.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all VoiceChannel names that match the provided name.
*/
default List<VoiceChannel> getVoiceChannelsByName(String name, boolean ignoreCase)
{
return getVoiceChannelCache().getElementsByName(name, ignoreCase);
}
/**
* Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView} of
* all cached {@link net.dv8tion.jda.core.entities.VoiceChannel VoiceChannels} of this Guild.
* <br>VoiceChannels are sorted according to their position.
*
* @return Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
SnowflakeCacheView<VoiceChannel> getVoiceChannelCache();
/**
* Gets a {@link net.dv8tion.jda.core.entities.Role Role} from this guild that has the same id as the
* one provided.
* <br>If there is no {@link net.dv8tion.jda.core.entities.Role Role} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.Role Role}.
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Role Role} with matching id.
*/
default Role getRoleById(String id)
{
return getRoleCache().getElementById(id);
}
/**
* Gets a {@link net.dv8tion.jda.core.entities.Role Role} from this guild that has the same id as the
* one provided.
* <br>If there is no {@link net.dv8tion.jda.core.entities.Role Role} with an id that matches the provided
* one, then this returns {@code null}.
*
* @param id
* The id of the {@link net.dv8tion.jda.core.entities.Role Role}.
*
* @return Possibly-null {@link net.dv8tion.jda.core.entities.Role Role} with matching id.
*/
default Role getRoleById(long id)
{
return getRoleCache().getElementById(id);
}
/**
* Gets all {@link net.dv8tion.jda.core.entities.Role Roles} in this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>The roles returned will be sorted according to their position.
*
* @return An immutable List of {@link net.dv8tion.jda.core.entities.Role Roles}.
*/
default List<Role> getRoles()
{
return getRoleCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Role Roles} in this Guild that have the same
* name as the one provided.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Role Roles} with the provided name, then this returns an empty list.
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.core.entities.Role Roles}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all Role names that match the provided name.
*/
default List<Role> getRolesByName(String name, boolean ignoreCase)
{
return getRoleCache().getElementsByName(name, ignoreCase);
}
/**
* Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView} of
* all cached {@link net.dv8tion.jda.core.entities.Role Roles} of this Guild.
* <br>Roles are sorted according to their position.
*
* @return Sorted {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
SnowflakeCacheView<Role> getRoleCache();
/**
* Gets an {@link net.dv8tion.jda.core.entities.Emote Emote} from this guild that has the same id as the
* one provided.
* <br>If there is no {@link net.dv8tion.jda.core.entities.Emote Emote} with an id that matches the provided
* one, then this returns {@code null}.
*
* <p><b>Unicode emojis are not included as {@link net.dv8tion.jda.core.entities.Emote Emote}!</b>
*
* @param id
* the emote id
*
* @throws java.lang.NumberFormatException
* If the provided {@code id} cannot be parsed by {@link Long#parseLong(String)}
*
* @return An Emote matching the specified Id.
*/
default Emote getEmoteById(String id)
{
return getEmoteCache().getElementById(id);
}
/**
* Gets an {@link net.dv8tion.jda.core.entities.Emote Emote} from this guild that has the same id as the
* one provided.
* <br>If there is no {@link net.dv8tion.jda.core.entities.Emote Emote} with an id that matches the provided
* one, then this returns {@code null}.
*
* <p><b>Unicode emojis are not included as {@link net.dv8tion.jda.core.entities.Emote Emote}!</b>
*
* @param id
* the emote id
*
* @return An Emote matching the specified Id.
*/
default Emote getEmoteById(long id)
{
return getEmoteCache().getElementById(id);
}
/**
* Gets all custom {@link net.dv8tion.jda.core.entities.Emote Emotes} belonging to this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>Emotes are not ordered in any specific way in the returned list.
*
* <p><b>Unicode emojis are not included as {@link net.dv8tion.jda.core.entities.Emote Emote}!</b>
*
* @return An immutable List of {@link net.dv8tion.jda.core.entities.Emote Emotes}.
*/
default List<Emote> getEmotes()
{
return getEmoteCache().asList();
}
/**
* Gets a list of all {@link net.dv8tion.jda.core.entities.Emote Emotes} in this Guild that have the same
* name as the one provided.
* <br>If there are no {@link net.dv8tion.jda.core.entities.Emote Emotes} with the provided name, then this returns an empty list.
*
* <p><b>Unicode emojis are not included as {@link net.dv8tion.jda.core.entities.Emote Emote}!</b>
*
* @param name
* The name used to filter the returned {@link net.dv8tion.jda.core.entities.Emote Emotes}.
* @param ignoreCase
* Determines if the comparison ignores case when comparing. True - case insensitive.
*
* @return Possibly-empty immutable list of all Role names that match the provided name.
*/
default List<Emote> getEmotesByName(String name, boolean ignoreCase)
{
return getEmoteCache().getElementsByName(name, ignoreCase);
}
/**
* {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView} of
* all cached {@link net.dv8tion.jda.core.entities.Emote Emotes} of this Guild.
*
* @return {@link net.dv8tion.jda.core.utils.cache.SnowflakeCacheView SnowflakeCacheView}
*/
SnowflakeCacheView<Emote> getEmoteCache();
/**
* Gets an unmodifiable list of the currently banned {@link net.dv8tion.jda.core.entities.User Users}.
* <br>If you wish to ban or unban a user, please {@link GuildController#ban(User, int) GuildController.ban(User, int)} or
* {@link GuildController#unban(User) GuildController.ban(User)}.
*
* <p>Possible {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.core.requests.RestAction RestAction} include the following:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The ban list cannot be fetched due to a permission discrepancy</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>We were removed from the Guild before finishing the task</li>
* </ul>
*
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* If the logged in account does not have the {@link net.dv8tion.jda.core.Permission#BAN_MEMBERS} permission.
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* If the guild is temporarily not {@link #isAvailable() available}
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: {@literal List<}{@link net.dv8tion.jda.core.entities.Guild.Ban Ban}{@literal >}
* <br>An unmodifiable list of all users currently banned from this Guild
*/
@Nonnull
@CheckReturnValue
RestAction<List<Ban>> getBanList();
/**
* The method calculates the amount of Members that would be pruned if {@link GuildController#prune(int)} was executed.
* Prunability is determined by a Member being offline for at least <i>days</i> days.
*
* <p>Possible {@link net.dv8tion.jda.core.requests.ErrorResponse ErrorResponses} caused by
* the returned {@link net.dv8tion.jda.core.requests.RestAction RestAction} include the following:
* <ul>
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_PERMISSIONS MISSING_PERMISSIONS}
* <br>The prune count cannot be fetched due to a permission discrepancy</li>
*
* <li>{@link net.dv8tion.jda.core.requests.ErrorResponse#MISSING_ACCESS MISSING_ACCESS}
* <br>We were removed from the Guild before finishing the task</li>
* </ul>
*
* @param days
* Minimum number of days since a member has been offline to get affected.
*
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* If the account doesn't have {@link net.dv8tion.jda.core.Permission#KICK_MEMBERS KICK_MEMBER} Permission.
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* If the guild is temporarily not {@link #isAvailable() available}
* @throws IllegalArgumentException
* If the provided days are less than {@code 1}
*
* @return {@link net.dv8tion.jda.core.requests.RestAction RestAction} - Type: Integer
* <br>The amount of Members that would be affected.
*/
@CheckReturnValue
RestAction<Integer> getPrunableMemberCount(int days);
/**
* The @everyone {@link net.dv8tion.jda.core.entities.Role Role} of this {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>This role is special because its {@link net.dv8tion.jda.core.entities.Role#getPosition() position} is calculated as
* {@code -1}. All other role positions are 0 or greater. This implies that the public role is <b>always</b> below
* any custom roles created in this Guild. Additionally, all members of this guild are implied to have this role so
* it is not included in the list returned by {@link net.dv8tion.jda.core.entities.Member#getRoles() Member.getRoles()}.
* <br>The ID of this Role is the Guild's ID thus it is equivalent to using {@link #getRoleById(long) getRoleById(getIdLong())}.
*
* @return The @everyone {@link net.dv8tion.jda.core.entities.Role Role}
*/
Role getPublicRole();
/**
* The default {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} for a {@link net.dv8tion.jda.core.entities.Guild Guild}.
* <br>This is the channel that the Discord client will default to opening when a Guild is opened for the first time when accepting an invite
* that is not directed at a specific {@link net.dv8tion.jda.core.entities.TextChannel TextChannel}.
*
* <p>Note: This channel is the first channel in the guild (ordered by position) that the {@link #getPublicRole()}
* has the {@link net.dv8tion.jda.core.Permission#MESSAGE_READ Permission.MESSAGE_READ} in.
*
* @return The {@link net.dv8tion.jda.core.entities.TextChannel TextChannel} representing the default channel for this guild
*/
@Nullable
TextChannel getDefaultChannel();
/**
* Returns the {@link net.dv8tion.jda.core.managers.GuildManager GuildManager} for this Guild, used to modify
* all properties and settings of the Guild.
* <br>You modify multiple fields in one request by chaining setters before calling {@link net.dv8tion.jda.core.requests.RestAction#queue() RestAction.queue()}.
*
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* if the guild is temporarily unavailable ({@link #isAvailable()})
* @throws net.dv8tion.jda.core.exceptions.InsufficientPermissionException
* If the currently logged in account does not have {@link net.dv8tion.jda.core.Permission#MANAGE_SERVER Permission.MANAGE_SERVER}
*
* @return The Manager of this Guild
*/
GuildManager getManager();
/**
* Returns the {@link net.dv8tion.jda.core.managers.GuildManagerUpdatable Updatable GuildManager} for this Guild, used to modify
* all properties and settings of the Guild.
* <br>This manager type is the Updatable type. This means that multiple changes can be made before a REST request is
* sent to Discord. This manager type is great for clients which wish to display all modifiable fields and update
* the entity using an "apply" button or something similar.
*
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* if the guild is temporarily unavailable ({@link #isAvailable()})
*
* @return The Updatable Manager of this Guild
*
* @deprecated
* Use {@link #getManager()} instead
*/
@Deprecated
GuildManagerUpdatable getManagerUpdatable();
/**
* Returns the {@link net.dv8tion.jda.core.managers.GuildController GuildController} for this Guild. The controller
* is used to perform all admin style functions in the Guild. A few include: kicking, banning, changing member roles,
* changing role and channel positions, and more. Checkout the {@link net.dv8tion.jda.core.managers.GuildController GuildController}
* class for more info.
*
* @return The controller for this Guild.
*/
GuildController getController();
/**
* Retrieves the recent mentions for the currently logged in
* client account in this Guild.
*
* <p>The returned {@link net.dv8tion.jda.client.requests.restaction.pagination.MentionPaginationAction MentionPaginationAction}
* allows to filter by whether the messages mention everyone or a role.
*
* @throws net.dv8tion.jda.core.exceptions.AccountTypeException
* If the currently logged in account is not from {@link net.dv8tion.jda.core.AccountType#CLIENT AccountType.CLIENT}
* @throws net.dv8tion.jda.core.exceptions.GuildUnavailableException
* If this Guild is not currently {@link #isAvailable() available}
*
* @return {@link net.dv8tion.jda.client.requests.restaction.pagination.MentionPaginationAction MentionPaginationAction}
*
* @see net.dv8tion.jda.core.JDA#asClient()
* @see net.dv8tion.jda.client.JDAClient#getRecentMentions(Guild)
*/
@CheckReturnValue
MentionPaginationAction getRecentMentions();
/**
* A {@link net.dv8tion.jda.core.requests.restaction.pagination.PaginationAction PaginationAction} implementation
* that allows to {@link Iterable iterate} over all {@link net.dv8tion.jda.core.audit.AuditLogEntry AuditLogEntries} of
* this Guild.
* <br>This iterates from the most recent action to the first logged one. (Limit 90 days into history by discord api)
*
* <h1>Examples</h1>
* <pre><code>
* public boolean isLogged(Guild guild, ActionType type, long targetId)
* {