forked from bwmarrin/discordgo
-
Notifications
You must be signed in to change notification settings - Fork 0
/
structs.go
1722 lines (1421 loc) · 58.8 KB
/
structs.go
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
// Discordgo - Discord bindings for Go
// Available at https://github.com/bwmarrin/discordgo
// Copyright 2015-2016 Bruce Marriner <bruce@sqls.net>. All rights reserved.
// Use of this source code is governed by a BSD-style
// license that can be found in the LICENSE file.
// This file contains all structures for the discordgo package. These
// may be moved about later into separate files but I find it easier to have
// them all located together.
package discordgo
import (
"bytes"
"encoding/json"
"fmt"
"net/http"
"strings"
"sync"
"time"
"github.com/gorilla/websocket"
)
// A Session represents a connection to the Discord API.
type Session struct {
sync.RWMutex
// General configurable settings.
// Authentication token for this session
Token string
MFA bool
// Debug for printing JSON request/responses
Debug bool // Deprecated, will be removed.
LogLevel int
// Should the session reconnect the websocket on errors.
ShouldReconnectOnError bool
// Should the session request compressed websocket data.
Compress bool
// Sharding
ShardID int
ShardCount int
// Should state tracking be enabled.
// State tracking is the best way for getting the the users
// active guilds and the members of the guilds.
StateEnabled bool
// Whether or not to call event handlers synchronously.
// e.g false = launch event handlers in their own goroutines.
SyncEvents bool
// Exposed but should not be modified by User.
// Whether the Data Websocket is ready
DataReady bool // NOTE: Maye be deprecated soon
// Max number of REST API retries
MaxRestRetries int
// Status stores the currect status of the websocket connection
// this is being tested, may stay, may go away.
Status int32
// Whether the Voice Websocket is ready
VoiceReady bool // NOTE: Deprecated.
// Whether the UDP Connection is ready
UDPReady bool // NOTE: Deprecated
// Stores a mapping of guild id's to VoiceConnections
VoiceConnections map[string]*VoiceConnection
// Managed state object, updated internally with events when
// StateEnabled is true.
State *State
// The http client used for REST requests
Client *http.Client
// The user agent used for REST APIs
UserAgent string
// Stores the last HeartbeatAck that was recieved (in UTC)
LastHeartbeatAck time.Time
// Stores the last Heartbeat sent (in UTC)
LastHeartbeatSent time.Time
// used to deal with rate limits
Ratelimiter *RateLimiter
// Event handlers
handlersMu sync.RWMutex
handlers map[string][]*eventHandlerInstance
onceHandlers map[string][]*eventHandlerInstance
// The websocket connection.
wsConn *websocket.Conn
// When nil, the session is not listening.
listening chan interface{}
// sequence tracks the current gateway api websocket sequence number
sequence *int64
// stores sessions current Discord Gateway
gateway string
// stores session ID of current Gateway connection
sessionID string
// used to make sure gateway websocket writes do not happen concurrently
wsMutex sync.Mutex
// used to send intents to the gateway
Intents int
// used to track gateway guild member requests
gatewayRequests sync.Map // map[string]requestData
}
// UserConnection is a Connection returned from the UserConnections endpoint
type UserConnection struct {
ID string `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
Revoked bool `json:"revoked"`
Integrations []*Integration `json:"integrations"`
Verified bool `json:"verified"`
FriendSync bool `json:"friend_sync"`
ShowActivity bool `json:"show_activity"`
Visibility int `json:"visibility"` // 0 = None, 1 = Everyone
}
// Integration stores integration information
type Integration struct {
ID string `json:"id"`
Name string `json:"name"`
Type string `json:"type"`
Enabled bool `json:"enabled"`
Syncing bool `json:"syncing"`
RoleID string `json:"role_id"`
EnableEmoticons bool `json:"enable_emoticons"`
ExpireBehavior int `json:"expire_behavior"` // 0 = remove role, 1 = kick
ExpireGracePeriod int `json:"expire_grace_period"`
User *User `json:"user"`
Account IntegrationAccount `json:"account"`
SyncedAt Timestamp `json:"synced_at"`
}
// IntegrationAccount is integration account information
// sent by the UserConnections endpoint
type IntegrationAccount struct {
ID string `json:"id"`
Name string `json:"name"`
}
// A VoiceRegion stores data for a specific voice region server.
type VoiceRegion struct {
ID string `json:"id"`
Name string `json:"name"`
VIP bool `json:"vip"`
Optimal bool `json:"optimal"`
Deprecated bool `json:"deprecated"`
Custom bool `json:"custom"`
}
// A VoiceICE stores data for voice ICE servers.
type VoiceICE struct {
TTL string `json:"ttl"`
Servers []*ICEServer `json:"servers"`
}
// A ICEServer stores data for a specific voice ICE server.
type ICEServer struct {
URL string `json:"url"`
Username string `json:"username"`
Credential string `json:"credential"`
}
// A Invite stores all data related to a specific Discord Guild or Channel invite.
type Invite struct {
Code string `json:"code"`
Guild *Guild `json:"guild"`
Channel *Channel `json:"channel"`
Inviter *User `json:"inviter"`
Target *User `json:"target_user"`
TargetType int `json:"target_user_type"`
// will only be filled when using InviteWithCounts
ApproximatePresenceCount int `json:"approximate_presence_count"`
ApproximateMemberCount int `json:"approximate_member_count"`
// Metadata
Uses int `json:"uses"`
MaxUses int `json:"max_uses"`
MaxAge int `json:"max_age"`
Temporary bool `json:"temporary"`
CreatedAt Timestamp `json:"created_at"`
}
// ChannelType is the type of a Channel
type ChannelType int
// Block contains known ChannelType values
const (
ChannelTypeGuildText ChannelType = iota
ChannelTypeDM
ChannelTypeGuildVoice
ChannelTypeGroupDM
ChannelTypeGuildCategory
ChannelTypeGuildAnnouncement
ChannelTypeAnnouncementThread ChannelType = iota + 4
ChannelTypePublicThread
ChannelTypePrivateThread
ChannelTypeGuildStageVoice
ChannelTypeGuildDirectory
ChannelTypeGuildForum
)
// A Channel holds all data related to an individual Discord channel.
type Channel struct {
// The ID of the channel.
ID string `json:"id"`
// The type of the channel.
Type ChannelType `json:"type"`
// The ID of the guild to which the channel belongs, if it is in a guild.
// Else, this ID is empty (e.g. DM channels).
GuildID string `json:"guild_id"`
// The position of the channel, used for sorting in client.
Position int `json:"position"`
// A list of permission overwrites present for the channel.
PermissionOverwrites []*PermissionOverwrite `json:"permission_overwrites"`
// The name of the channel.
Name string `json:"name"`
// The topic of the channel.
Topic string `json:"topic"`
// Whether the channel is marked as NSFW.
NSFW bool `json:"nsfw"`
// The ID of the last message sent in the channel. This is not
// guaranteed to be an ID of a valid message.
LastMessageID string `json:"last_message_id"`
// The bitrate of the channel, if it is a voice channel.
Bitrate int `json:"bitrate"`
// The user limit of the voice channel.
UserLimit int `json:"user_limit"`
// Amount of seconds a user has to wait before sending another message (0-21600)
// bots, as well as users with the permission manage_messages or manage_channel, are unaffected
RateLimitPerUser int `json:"rate_limit_per_user"`
// The recipients of the channel. This is only populated in DM channels.
Recipients []*User `json:"recipients"`
// Icon of the group DM channel.
Icon string `json:"icon"`
// ID of the DM channel creator
OwnerID string `json:"owner_id"`
// Application ID of DM group creator if it was bot-created
ApplicationID string `json:"application_id"`
// The ID of the parent channel, if the channel is under a category
ParentID string `json:"parent_id"`
// The timestamp of the last pinned message in the channel.
// Empty if the channel has no pinned messages.
LastPinTimestamp *Timestamp `json:"last_pin_timestamp"`
// Voice region id for the voice channel, automatic when set to null
RTCRegion *string `json:"rtc_region"`
// The camera video quality mode of the voice channel, 1 when not present
VideoQualityMode *int `json:"video_quality_mode"`
// An approximate count of messages in a thread, stops counting at 50
MessageCount *int `json:"message_count"`
// An approximate count of users in a thread, stops counting at 50
MemberCount *int `json:"member_count"`
// Thread-specific fields not needed by other channels
ThreadMetadata *ThreadMetadata `json:"thread_metadata"`
// Thread member object for the current user, if they have joined the thread, only included on certain API endpoints
Member *ThreadMember `json:"member"`
// Default duration, copied onto newly created threads, in minutes,
// threads will stop showing in the channel list after the specified
// period of inactivity, can be set to: 60, 1440, 4320, 10080
DefaultAutoArchiveDuration *int `json:"default_auto_archive_duration"`
// Computed permissions for the invoking user in the channel, including overwrites,
// only included when part of the 'resolved' data received on a slash command interaction
Permissions *string `josn:"permissions"`
// Channel flags combined as a bitfield
Flags ChannelFlag `json:"flags"`
// Number of messages ever sent in a thread,
// it's similar to 'message_count' on message creation,
// but will not decrement the number when a message is deleted
TotalMessagesSent *int `json:"total_message_sent"`
// The set of tags that can be used in a 'GUILD_FORUM' channel
AvailableTags []*Tag `json:"available_tags"`
// The IDs of the set of tags that have been applied to a thread in a 'GUILD_FORUM' channel
AppliedTags []string `json:"applied_tags"`
// The emoji to show in the add reaction button on a thread in a 'GUILD_FORUM' channel
DefaultReactionEmoji *DefaultReaction `json:"default_reaction_emoji"`
// The initial 'rate_limit_per_user' to set on newly created threads in a channel.
// This field is copied to the thread at creation time and does not live update
DefaultThreadRateLimitPerUser *int `json:"default_thread_rate_limit_per_user"`
// the default sort order type used to order posts in 'GUILD_FORUM' channels.
// Defaults to 'null', which indicates a preferred sort order hasn't been set by a channel admin
DefaultSortOrder *SortOrder `json:"default_sort_order"`
// Non-Discord property
// The messages in the channel. This is only present in state-cached channels,
// and State.MaxMessageCount must be non-zero.
Messages []*Message `json:"-"`
}
type PartialChannel struct {
ID string `json:"id"`
Name string `json:"name"`
Type ChannelType `json:"type"`
PermissionOverwrites []*PermissionOverwrite `json:"permission_overwrites"`
}
// Mention returns a string which mentions the channel
func (c *Channel) Mention() string {
return fmt.Sprintf("<#%s>", c.ID)
}
type ChannelFlag int
const (
ChannelFlagPinned ChannelFlag = 1 << 1
ChannelFlagRequireTag ChannelFlag = 1 << 4
)
type SortOrder int
const (
SortOrderLatestActivity SortOrder = iota
SortOrderCreationDate
)
// A ChannelEdit holds Channel Field data for a channel edit.
type ChannelEdit struct {
Name string `json:"name,omitempty"`
Type ChannelType `json:"type,omitempty"` // Only on Guild with "NEWS" features and conversion between text and news
Position int `json:"position,omitempty"`
Topic string `json:"topic,omitempty"`
NSFW *bool `json:"nsfw,omitempty"`
RateLimitPerUser int `json:"rate_limit_per_user"`
Bitrate int `json:"bitrate,omitempty"`
UserLimit int `json:"user_limit,omitempty"`
PermissionOverwrites []*PermissionOverwrite `json:"permission_overwrites,omitempty"`
ParentID string `json:"parent_id,omitempty"`
}
// A ThreadEdit holds Thread Field data for a thread edit.
type ThreadEdit struct {
Name string `json:"name,omitempty"`
Archived *bool `json:"archived,omitempty"`
AutoArchiveDuration int `json:"auto_archive_duration,omitempty"`
Locked *bool `json:"locked,omitempty"`
RateLimitPerUser *int `json:"rate_limit_per_user,omitempty"`
}
type StartThread struct {
Name string `json:"name"`
AutoArchiveDuration int `json:"auto_archive_duration"`
Type ChannelType `json:"type,omitempty"`
}
type ThreadMetadata struct {
Archived bool `json:"archived"`
ArchiverID *string `json:"archiver_id"`
AutoArchiveDuration int `json:"auto_archive_duration"`
ArchiveTimestamp Timestamp `json:"archive_timestamp"`
Locked bool `json:"locked"`
}
type ThreadMember struct {
ID string `json:"id"`
UserID string `json:"user_id"`
JoinTimestamp Timestamp `json:"join_timestamp"`
Flags int `json:"flags"`
}
// FollowChannel structure holds information from ChannelFollow function
type FollowChannel struct {
ChannelID string `json:"channel_id"`
WebHookID string `json:"webhook_id"`
}
// A PermissionOverwrite holds permission overwrite data for a Channel
type PermissionOverwrite struct {
ID string `json:"id"`
Type PermissionOverwriteType `json:"type"`
Deny int `json:"deny,string"`
Allow int `json:"allow,string"`
}
type PermissionOverwriteType int
const (
PermissionOverwriteTypeRole PermissionOverwriteType = 0
PermissionOverwriteTypeMember PermissionOverwriteType = 1
)
// Emoji struct holds data related to Emoji's
type Emoji struct {
ID NullString `json:"id"`
Name string `json:"name"`
Roles *[]string `json:"roles"`
User *User `json:"user"`
RequireColons bool `json:"require_colons"`
Managed bool `json:"managed"`
Animated bool `json:"animated"`
Available bool `json:"available"`
}
type NullString string
func (n NullString) MarshalJSON() ([]byte, error) {
var buf bytes.Buffer
if len(n) == 0 {
buf.WriteString("null")
} else {
buf.WriteString(`"` + string(n) + `"`)
}
return buf.Bytes(), nil
}
func (n *NullString) UnmarshalJSON(in []byte) error {
str := string(in)
if str == "null" {
str = ""
return nil
}
ns := NullString(str)
if len(ns) >= 2 {
ns = ns[1 : len(ns)-1]
}
*n = ns
return nil
}
// MessageFormat returns a correctly formatted Emoji for use in Message content and embeds
func (e *Emoji) MessageFormat() string {
if e.ID != "" && e.Name != "" {
if e.Animated {
return "<a:" + e.APIName() + ">"
}
return "<:" + e.APIName() + ">"
}
return e.APIName()
}
// APIName returns an correctly formatted API name for use in the MessageReactions endpoints.
func (e *Emoji) APIName() string {
if e.ID != "" && e.Name != "" {
return e.Name + ":" + string(e.ID)
}
if e.Name != "" {
return e.Name
}
return string(e.ID)
}
// VerificationLevel type definition
type VerificationLevel int
// Constants for VerificationLevel levels from 0 to 4 inclusive
const (
VerificationLevelNone VerificationLevel = iota
VerificationLevelLow
VerificationLevelMedium
VerificationLevelHigh
VerificationLevelVeryHigh
)
// ExplicitContentFilterLevel type definition
type ExplicitContentFilterLevel int
// Constants for ExplicitContentFilterLevel levels from 0 to 2 inclusive
const (
ExplicitContentFilterDisabled ExplicitContentFilterLevel = iota
ExplicitContentFilterMembersWithoutRoles
ExplicitContentFilterAllMembers
)
// MfaLevel type definition
type MfaLevel int
// Constants for MfaLevel levels from 0 to 1 inclusive
const (
MfaLevelNone MfaLevel = iota
MfaLevelElevated
)
// PremiumTier type definition
type PremiumTier int
// Constants for PremiumTier levels from 0 to 3 inclusive
const (
PremiumTierNone PremiumTier = iota
PremiumTier1
PremiumTier2
PremiumTier3
)
// A Guild holds all data related to a specific Discord Guild. Guilds are also
// sometimes referred to as Servers in the Discord client.
type Guild struct {
// The ID of the guild.
ID string `json:"id"`
// The name of the guild. (2–100 characters)
Name string `json:"name"`
// The hash of the guild's icon. Use Session.GuildIcon
// to retrieve the icon itself.
Icon string `json:"icon"`
// The hash of the guild's splash.
Splash string `json:"splash"`
// The Hash of the guild's discovery splash. Only available for guilds with "DISCOVERABLE" feature
DiscoverySplash string `json:"discovery_splash"`
// The user ID of the owner of the guild.
OwnerID string `json:"owner_id"`
// The voice region of the guild.
Region string `json:"region"`
// The ID of the AFK voice channel.
AfkChannelID string `json:"afk_channel_id"`
// The timeout, in seconds, before a user is considered AFK in voice.
AfkTimeout int `json:"afk_timeout"`
// Whether or not the Server Widget is enabled
WidgetEnabled bool `json:"widget_enabled"`
// The Channel ID for the Server Widget
WidgetChannelID string `json:"widget_channel_id"`
// The verification level required for the guild.
VerificationLevel VerificationLevel `json:"verification_level"`
// The default message notification setting for the guild.
// 0 == all messages, 1 == mentions only.
DefaultMessageNotifications int `json:"default_message_notifications"`
// The explicit content filter level
ExplicitContentFilter ExplicitContentFilterLevel `json:"explicit_content_filter"`
// A list of roles in the guild.
Roles []*Role `json:"roles"`
// A list of the custom emojis present in the guild.
Emojis []*Emoji `json:"emojis"`
// The list of enabled guild features
Features []string `json:"features"`
// Required MFA level for the guild
MfaLevel MfaLevel `json:"mfa_level"`
// Application ID of the Guild Creator if it is bot-created
ApplicationID string `json:"application_id"`
// The Channel ID to which system messages are sent (eg join and leave messages)
SystemChannelID string `json:"system_channel_id"`
// System Channel Flags
SystemChannelFlags int `json:"system_channel_flags"`
// Channel ID of the channel where guilds with "PUBLIC" feature can display rules and/or guidelines
RulesChannelID string `json:"rules_channel_id"`
// The time at which the current user joined the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
JoinedAt Timestamp `json:"joined_at"`
// Whether the guild is considered large. This is
// determined by a member threshold in the identify packet,
// and is currently hard-coded at 250 members in the library.
Large bool `json:"large"`
// Whether this guild is currently unavailable (most likely due to outage).
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
Unavailable bool `json:"unavailable"`
// The number of members in the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
MemberCount int `json:"member_count"`
// A list of voice states for the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
VoiceStates []*VoiceState `json:"voice_states"`
// A list of the members in the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
Members []*Member `json:"members"`
// A list of channels in the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
Channels []*Channel `json:"channels"`
// A list of partial presence objects for members in the guild.
// This field is only present in GUILD_CREATE events and websocket
// update events, and thus is only present in state-cached guilds.
Presences []*Presence `json:"presences"`
// The maximum number of presences for the guild (if nil, assume the default value, currently of 25000)
MaxPresences *int `json:"max_presences"`
// The maximum number of member fot the guild
MaxMembers int `json:"max_members"`
// the vanity url code for the guild
VanityURLCode string `json:"vanity_url_code"`
// the description for the guild
Description string `json:"description"`
// The hash of the guild's banner
Banner string `json:"banner"`
// The premium tier of the guild
PremiumTier PremiumTier `json:"premium_tier"`
// The total number of users currently boosting this server
PremiumSubscriptionCount int `json:"premium_subscription_count"`
// Preferred Local for guild with "PUBLIC" feature. Defaults to "en_US"
PreferredLocale string `json:"preferred_locale"`
// Channel ID of the channel where guilds with "PUBLIC" feature receive notices from Discord
PublicUpdatesChannelID string `json:"public_updates_channel_id"`
// The maximum amount of users in video channel
MaxVideoChannelUsers int `json:"max_video_channel_users"`
// Approximate member count
ApproximateMemberCount int `json:"approximate_member_count"`
// Approximate presence count
ApproximatePresenceCount int `json:"approximate_presence_count"`
}
// IconURL returns a URL to the guild's icon.
func (g *Guild) IconURL() string {
if g.Icon == "" {
return ""
}
if strings.HasPrefix(g.Icon, "a_") {
return EndpointGuildIconAnimated(g.ID, g.Icon)
}
return EndpointGuildIcon(g.ID, g.Icon)
}
// A UserGuild holds a brief version of a Guild
type UserGuild struct {
ID string `json:"id"`
Name string `json:"name"`
Icon string `json:"icon"`
Owner bool `json:"owner"`
Permissions int `json:"permissions,string"`
}
// A GuildParams stores all the data needed to update discord guild settings
type GuildParams struct {
Name string `json:"name,omitempty"`
Region string `json:"region,omitempty"`
VerificationLevel *VerificationLevel `json:"verification_level,omitempty"`
DefaultMessageNotifications int `json:"default_message_notifications,omitempty"` // TODO: Separate type?
ExplicitContentFilter ExplicitContentFilterLevel `json:"explicit_content_filter,omitempty"`
AfkChannelID string `json:"afk_channel_id,omitempty"`
AfkTimeout int `json:"afk_timeout,omitempty"`
Icon string `json:"icon,omitempty"`
OwnerID string `json:"owner_id,omitempty"`
Splash string `json:"splash,omitempty"`
Banner string `json:"banner,omitempty"`
SystemChannelID string `json:"system_channel_id,omitempty"`
RulesChannelID string `json:"rules_channel_id,omitempty"`
PublicUpdatesChannelID string `json:"public_updates_channel_id,omitempty"`
PreferredLocale string `json:"preferred_locale,omitempty"`
}
// A short summary of a discoverable guild available to anyone
type GuildPreview struct {
ID string `json:"id"`
Name string `json:"name"`
Icon string `json:"icon"`
Splash string `json:"splash"`
DiscoverySplash string `json:"discovery_splash"`
Emojis []*Emoji `json:"emojis"`
Features []string `json:"features"`
ApproximateMemberCount int `json:"approximate_member_count"`
ApproximatePresenceCount int `json:"approximate_presence_count"`
Description string `json:"description"`
}
// A Role stores information about Discord guild member roles.
type Role struct {
// The ID of the role.
ID string `json:"id"`
// The name of the role.
Name string `json:"name"`
// The hex color of this role.
Color int `json:"color"`
// Whether this role is hoisted (shows up separately in member list).
Hoist bool `json:"hoist"`
// The position of this role in the guild's role hierarchy.
Position int `json:"position"`
// The permissions of the role on the guild (doesn't include channel overrides).
// This is a combination of bit masks; the presence of a certain permission can
// be checked by performing a bitwise AND between this int and the permission.
Permissions int `json:"permissions,string"`
// Whether this role is managed by an integration, and
// thus cannot be manually added to, or taken from, members.
Managed bool `json:"managed"`
// Whether this role is mentionable.
Mentionable bool `json:"mentionable"`
}
// Mention returns a string which mentions the role
func (r *Role) Mention() string {
return fmt.Sprintf("<@&%s>", r.ID)
}
// Roles are a collection of Role
type Roles []*Role
func (r Roles) Len() int {
return len(r)
}
func (r Roles) Less(i, j int) bool {
return r[i].Position > r[j].Position
}
func (r Roles) Swap(i, j int) {
r[i], r[j] = r[j], r[i]
}
// A VoiceState stores the voice states of Guilds
type VoiceState struct {
GuildID string `json:"guild_id"`
ChannelID string `json:"channel_id"`
UserID string `json:"user_id"`
Member *Member `json:"member"`
SessionID string `json:"session_id"`
Deaf bool `json:"deaf"`
Mute bool `json:"mute"`
SelfDeaf bool `json:"self_deaf"`
SelfMute bool `json:"self_mute"`
SelfStream bool `json:"self_stream"`
SelfVideo bool `json:"self_video"`
Suppress bool `json:"suppress"`
}
// A Presence stores the online, offline, or idle and game status of Guild members.
type Presence struct {
User *User `json:"user"`
GuildID string `json:"guild_id"`
Status Status `json:"status"`
Activities []*Activity `json:"activities"`
ClientStatus ClientStatus `json:"client_status"`
}
// ActivityType is the type of "activity" (see ActivityType* consts) in the Activity struct
type ActivityType int
// Valid ActivityType values
const (
ActivityTypeGame ActivityType = iota
ActivityTypeStreaming
ActivityTypeListening
ActivityTypeWatching
ActivityTypeCustom
ActivityTypeCompeting
)
// A Activity struct holds the name of the "playing .." activity for a user
type Activity struct {
Name string `json:"name"`
Type ActivityType `json:"type"`
URL string `json:"url,omitempty"`
CreatedAt int `json:"created_at"`
Timestamps Timestamps `json:"timestamps,omitempty"`
ApplicationID string `json:"application_id,omitempty"`
Details string `json:"details,omitempty"`
State string `json:"state,omitempty"`
Emoji GatewayEmoji `json:"emoji,omitempty"`
Party Party `json:"party,omitempty"`
Assets Assets `json:"assets,omitempty"`
Secrets Secrets `json:"secrets,omitempty"`
Instance bool `json:"instance,omitempty"`
Flags int `json:"flags,omitempty"`
}
type GatewayEmoji struct {
ID *string `json:"id"`
Name *string `json:"name"`
Animated *bool `json:"animated,omitempty"`
}
// A ClientStatus struct holds information about the users platform
type ClientStatus struct {
Desktop *Status `json:"desktop"`
Mobile *Status `json:"mobile"`
Web *Status `json:"web"`
}
// A TimeStamps struct contains start and end times used in the rich presence "playing .." Activity
type Timestamps struct {
StartTimestamp int64 `json:"start,omitempty"`
EndTimestamp int64 `json:"end,omitempty"`
}
// UnmarshalJSON unmarshals JSON into TimeStamps struct
func (t *Timestamps) UnmarshalJSON(b []byte) error {
temp := struct {
End float64 `json:"end,omitempty"`
Start float64 `json:"start,omitempty"`
}{}
err := json.Unmarshal(b, &temp)
if err != nil {
return err
}
t.EndTimestamp = int64(temp.End)
t.StartTimestamp = int64(temp.Start)
return nil
}
// An Assets struct contains assets and labels used in the rich presence "playing .." Activity
type Assets struct {
LargeImageID string `json:"large_image,omitempty"`
LargeText string `json:"large_text,omitempty"`
SmallImageID string `json:"small_image,omitempty"`
SmallText string `json:"small_text,omitempty"`
}
// An Party struct contains the id and size of a party used in rich presence Activity
type Party struct {
ID string `json:"id,omitempty"`
Size []int `json:"size,omitempty"`
}
// An Secrets struct contains secrets for rich presence Activity
type Secrets struct {
Join string `json:"join,omitempty"`
Spectate string `json:"spectate,omitempty"`
Match string `json:"match,omitempty"`
}
// A Member stores user information for Guild members. A guild
// member represents a certain user's presence in a guild.
type Member struct {
// The underlying user on which the member is based.
User *User `json:"user"`
// The nickname of the member, if they have one.
Nick string `json:"nick"`
// The member's guild avatar hash
Avatar *string `json:"avatar"`
// A list of IDs of the roles which are possessed by the member.
Roles []string `json:"roles"`
// The time at which the member joined the guild, in ISO8601.
JoinedAt Timestamp `json:"joined_at"`
// When the user used their Nitro boost on the server
PremiumSince Timestamp `json:"premium_since"`
// Whether the member is deafened at a guild level.
Deaf bool `json:"deaf"`
// Whether the member is muted at a guild level.
Mute bool `json:"mute"`
// Member guild flags
Flags MemberFlags `json:"flags"`
// Whether the user has not yet passed the guild's Membership Screening requirements
Pending *bool `json:"pending"`
// Total permissions of the member in the channel, including overwrites, returned when in the interaction object
Permissions *string `json:"permissions"`
// When the user's timeout will expire
// and the user will be able to communicate in the guild again,
// null or a time in the past if the user is not timed out
CommunicationDisabledUntil *Timestamp `json:"communication_disabled_until"`
// The guild ID on which the member exists.
// This property is not provided by Discord. I only left it here to not break the state.go
GuildID string `json:"guild_id"`
}
type MemberFlags int
const (
MemberFlagsDigRejoin MemberFlags = 1 << iota
MemberFlagsCompletedOnboarding
MemberFlagsBypassesVerification
MemberFlagsStartedOnboarding
)
// Mention creates a member mention
func (m *Member) Mention() string {
return m.User.Mention()
}
func (m *Member) AvatarURL(size string) string {
var URL string
if m.Avatar == nil || *m.Avatar == "" {
URL = m.User.AvatarURL("")
} else if strings.HasPrefix(*m.Avatar, "a_") {
URL = EndpointGuildMemberAvatarAnimated(m.GuildID, m.User.ID, *m.Avatar)
} else {
URL = EndpointGuildMemberAvatar(m.GuildID, m.User.ID, *m.Avatar)
}
if size != "" {
return URL + "?size=" + size
}
return URL
}
// A Settings stores data for a specific users Discord client settings.
type Settings struct {
RenderEmbeds bool `json:"render_embeds"`
InlineEmbedMedia bool `json:"inline_embed_media"`
InlineAttachmentMedia bool `json:"inline_attachment_media"`
EnableTtsCommand bool `json:"enable_tts_command"`
MessageDisplayCompact bool `json:"message_display_compact"`
ShowCurrentGame bool `json:"show_current_game"`
ConvertEmoticons bool `json:"convert_emoticons"`
Locale string `json:"locale"`
Theme string `json:"theme"`
GuildPositions []string `json:"guild_positions"`
RestrictedGuilds []string `json:"restricted_guilds"`
FriendSourceFlags *FriendSourceFlags `json:"friend_source_flags"`
Status Status `json:"status"`
DetectPlatformAccounts bool `json:"detect_platform_accounts"`
DeveloperMode bool `json:"developer_mode"`