mirror of
https://github.com/diamondburned/arikawa.git
synced 2024-08-21 15:54:48 +00:00
This commit refactored several structures from package discord to be in package gateway. Those structures are mostly presence ones, which per official documentation has a lot more to do with the Gateway API than the REST API or anything else. This commit also renamed several global variables to have a more consistent and obvious name. As of v8, the user API has had a lot of minor and some major changes, especially regarding its Ready event API. The most significant change is the addition of the ReadySupplemental event as well as several changes to the Ready field itself. All of these changes above are breaking, and they have already broken the state package. These breaking changes will be addressed in other packages by the next commit.
213 lines
4.7 KiB
Go
213 lines
4.7 KiB
Go
package discord
|
|
|
|
import (
|
|
"strconv"
|
|
)
|
|
|
|
type User struct {
|
|
ID UserID `json:"id"`
|
|
Username string `json:"username"`
|
|
Discriminator string `json:"discriminator"`
|
|
Avatar Hash `json:"avatar"`
|
|
|
|
// These fields may be omitted
|
|
|
|
Bot bool `json:"bot,omitempty"`
|
|
MFA bool `json:"mfa_enabled,omitempty"`
|
|
|
|
Nitro UserNitro `json:"premium_type,omitempty"`
|
|
Flags UserFlags `json:"flags,omitempty"`
|
|
PublicFlags UserFlags `json:"public_flags,omitempty"`
|
|
|
|
DiscordSystem bool `json:"system,omitempty"`
|
|
EmailVerified bool `json:"verified,omitempty"`
|
|
|
|
Locale string `json:"locale,omitempty"`
|
|
Email string `json:"email,omitempty"`
|
|
}
|
|
|
|
func (u User) Mention() string {
|
|
return u.ID.Mention()
|
|
}
|
|
|
|
// AvatarURL returns the URL of the Avatar Image. It automatically detects a
|
|
// suitable type.
|
|
func (u User) AvatarURL() string {
|
|
return u.AvatarURLWithType(AutoImage)
|
|
}
|
|
|
|
// AvatarURLWithType returns the URL of the Avatar Image using the passed type.
|
|
// If the user has no Avatar, his default avatar will be returned. This
|
|
// requires ImageType Auto or PNG
|
|
//
|
|
// Supported Image Types: PNG, JPEG, WebP, GIF (read above for caveat)
|
|
func (u User) AvatarURLWithType(t ImageType) string {
|
|
if u.Avatar == "" {
|
|
if t != PNGImage && t != AutoImage {
|
|
return ""
|
|
}
|
|
|
|
disc, err := strconv.Atoi(u.Discriminator)
|
|
if err != nil { // this should never happen
|
|
return ""
|
|
}
|
|
picNo := strconv.Itoa(disc % 5)
|
|
|
|
return "https://cdn.discordapp.com/embed/avatars/" + picNo + ".png"
|
|
}
|
|
|
|
return "https://cdn.discordapp.com/avatars/" + u.ID.String() + "/" + t.format(u.Avatar)
|
|
}
|
|
|
|
type UserFlags uint32
|
|
|
|
const NoFlag UserFlags = 0
|
|
|
|
const (
|
|
Employee UserFlags = 1 << iota
|
|
Partner
|
|
HypeSquadEvents
|
|
BugHunterLvl1
|
|
_
|
|
_
|
|
HouseBravery
|
|
HouseBrilliance
|
|
HouseBalance
|
|
EarlySupporter
|
|
TeamUser
|
|
_
|
|
System
|
|
_
|
|
BugHunterLvl2
|
|
_
|
|
VerifiedBot
|
|
VerifiedBotDeveloper
|
|
)
|
|
|
|
type UserNitro uint8
|
|
|
|
const (
|
|
NoUserNitro UserNitro = iota
|
|
NitroClassic
|
|
NitroFull
|
|
)
|
|
|
|
type Connection struct {
|
|
ID string `json:"id"`
|
|
Name string `json:"name"`
|
|
Type Service `json:"type"`
|
|
|
|
Revoked bool `json:"revoked"`
|
|
Verified bool `json:"verified"`
|
|
FriendSync bool `json:"friend_sync"`
|
|
ShowActivity bool `json:"show_activity"`
|
|
|
|
Visibility ConnectionVisibility `json:"visibility"`
|
|
|
|
// Only partial
|
|
Integrations []Integration `json:"integrations"`
|
|
}
|
|
|
|
type ConnectionVisibility uint8
|
|
|
|
const (
|
|
ConnectionNotVisible ConnectionVisibility = iota
|
|
ConnectionVisibleEveryone
|
|
)
|
|
|
|
type Activity struct {
|
|
Name string `json:"name"`
|
|
URL URL `json:"url,omitempty"`
|
|
|
|
Type ActivityType `json:"type"`
|
|
|
|
// User only
|
|
|
|
Instance bool `json:"instance,omitempty"`
|
|
Flags ActivityFlags `json:"flags,omitempty"`
|
|
|
|
CreatedAt UnixTimestamp `json:"created_at,omitempty"`
|
|
Timestamps *ActivityTimestamp `json:"timestamps,omitempty"`
|
|
|
|
ApplicationID AppID `json:"application_id,omitempty"`
|
|
Details string `json:"details,omitempty"`
|
|
State string `json:"state,omitempty"` // party status
|
|
Emoji *Emoji `json:"emoji,omitempty"`
|
|
|
|
Party *ActivityParty `json:"party,omitempty"`
|
|
Assets *ActivityAssets `json:"assets,omitempty"`
|
|
Secrets *ActivitySecrets `json:"secrets,omitempty"`
|
|
|
|
// Undocumented fields
|
|
SyncID string `json:"sync_id,omitempty"`
|
|
SessionID string `json:"session_id,omitempty"`
|
|
}
|
|
|
|
type ActivityType uint8
|
|
|
|
const (
|
|
// Playing $name
|
|
GameActivity ActivityType = iota
|
|
// Streaming $details
|
|
StreamingActivity
|
|
// Listening to $name
|
|
ListeningActivity
|
|
// Watching $name
|
|
WatchingActivity
|
|
// $emoji $state
|
|
CustomActivity
|
|
)
|
|
|
|
type ActivityFlags uint32
|
|
|
|
const (
|
|
InstanceActivity ActivityFlags = 1 << iota
|
|
JoinActivity
|
|
SpectateActivity
|
|
JoinRequestActivity
|
|
SyncActivity
|
|
PlayActivity
|
|
)
|
|
|
|
type ActivityTimestamp struct {
|
|
Start UnixMsTimestamp `json:"start,omitempty"`
|
|
End UnixMsTimestamp `json:"end,omitempty"`
|
|
}
|
|
|
|
type ActivityParty struct {
|
|
ID string `json:"id,omitempty"`
|
|
Size [2]int `json:"size,omitempty"` // [ current, max ]
|
|
}
|
|
|
|
type ActivityAssets struct {
|
|
LargeImage string `json:"large_image,omitempty"` // id
|
|
LargeText string `json:"large_text,omitempty"`
|
|
SmallImage string `json:"small_image,omitempty"` // id
|
|
SmallText string `json:"small_text,omitempty"`
|
|
}
|
|
|
|
type ActivitySecrets struct {
|
|
Join string `json:"join,omitempty"`
|
|
Spectate string `json:"spectate,omitempty"`
|
|
Match string `json:"match,omitempty"`
|
|
}
|
|
|
|
// A Relationship between the logged in user and the user in the struct. This
|
|
// struct is undocumented.
|
|
type Relationship struct {
|
|
UserID UserID `json:"id"`
|
|
User User `json:"user"`
|
|
Type RelationshipType `json:"type"`
|
|
}
|
|
|
|
// RelationshipType is an enum for a relationship.
|
|
type RelationshipType uint8
|
|
|
|
const (
|
|
_ RelationshipType = iota
|
|
FriendRelationship
|
|
BlockedRelationship
|
|
IncomingFriendRequest
|
|
SentFriendRequest
|
|
)
|