Documentation
¶
Index ¶
- Constants
- func HasMessageFlag(flags, flag int) bool
- func IsEditableMessageType(msgType MessageType) bool
- func MarshalStoredUserSettingsData(settings UserSettingsData) ([]byte, error)
- func NormalizeMessageFlags(flags *int) int
- type Attachment
- type Audit
- type AuthFactor
- type AuthRecoveryCode
- type AuthTOTPFactor
- type Authentication
- type Avatar
- type Channel
- type ChannelMention
- type ChannelMentionType
- type ChannelRoles
- type ChannelRolesPermission
- type ChannelType
- type ChannelUserPermission
- type DMChannel
- type Devices
- type Discriminator
- type EmojiLookup
- type Friend
- type FriendRequest
- type GroupDMChannel
- type Guild
- type GuildBan
- type GuildChannel
- type GuildChannelUpdatePosition
- type GuildEmoji
- type GuildInvite
- type Icon
- type Member
- type Mention
- type Message
- type MessageType
- type NotificationsType
- type Reaction
- type ReactionSummary
- type Recovery
- type Registration
- type Role
- type RoleUpdatePosition
- type Status
- type ThreadMember
- type User
- type UserDMChannels
- type UserGuild
- type UserRole
- type UserRoles
- type UserSettings
- type UserSettingsAppearance
- type UserSettingsChannel
- type UserSettingsData
- func (s UserSettingsData) DeviceUsageOrder() []string
- func (s UserSettingsData) DevicesForKey(deviceKey string) Devices
- func (s *UserSettingsData) NormalizeCollections()
- func (s *UserSettingsData) SetDeviceUsageOrder(order []string)
- func (s *UserSettingsData) SetDevicesForKey(deviceKey string, devices Devices)
- func (s UserSettingsData) Validate() error
- type UserSettingsGuildFolders
- type UserSettingsGuilds
- type UserSettingsNotifications
- type UserSettingsUsers
- type UserUISounds
Constants ¶
View Source
const ( MessageFlagSuppressEmbeds = 1 << 2 MessageFlagBannedAuthor = 1 << 3 )
Variables ¶
This section is empty.
Functions ¶
func HasMessageFlag ¶ added in v1.7.0
func IsEditableMessageType ¶ added in v1.8.0
func IsEditableMessageType(msgType MessageType) bool
func MarshalStoredUserSettingsData ¶ added in v1.11.0
func MarshalStoredUserSettingsData(settings UserSettingsData) ([]byte, error)
func NormalizeMessageFlags ¶ added in v1.7.0
Types ¶
type Attachment ¶
type AuthFactor ¶ added in v1.11.0
type AuthFactor struct {
UserID int64 `db:"user_id"`
FactorID int64 `db:"factor_id"`
FactorType string `db:"factor_type"`
DisplayName string `db:"display_name"`
Status string `db:"status"`
CreatedAt time.Time `db:"created_at"`
VerifiedAt *time.Time `db:"verified_at"`
LastUsedAt *time.Time `db:"last_used_at"`
}
type AuthRecoveryCode ¶ added in v1.11.0
type AuthTOTPFactor ¶ added in v1.11.0
type AuthTOTPFactor struct {
UserID int64 `db:"user_id"`
FactorID int64 `db:"factor_id"`
SecretCiphertext []byte `db:"secret_ciphertext"`
SecretNonce []byte `db:"secret_nonce"`
Algorithm string `db:"algorithm"`
Digits int `db:"digits"`
PeriodSeconds int `db:"period_seconds"`
CreatedAt time.Time `db:"created_at"`
}
type Authentication ¶
type Channel ¶
type Channel struct {
Id int64 `db:"id"`
Name string `db:"name"`
Type ChannelType `db:"type"`
ParentID *int64 `db:"parent_id"`
CreatorID *int64 `db:"creator_id"`
Permissions *int64 `db:"permissions"`
Topic *string `db:"topic"`
VoiceRegion *string `db:"voice_region"`
Private bool `db:"private"`
Closed bool `db:"closed"`
LastMessage int64 `db:"last_message"`
MessageCount int64 `db:"message_count"`
MessagePosition int64 `db:"message_position"`
CreatedAt time.Time `db:"created_at"`
}
type ChannelMention ¶ added in v1.5.0
type ChannelMentionType ¶ added in v1.5.0
type ChannelMentionType int
const ( ChannelMentionUser ChannelMentionType = iota ChannelMentionRole ChannelMentionEveryone ChannelMentionHere )
type ChannelRoles ¶ added in v1.4.0
type ChannelRoles struct {
ChannelId int64 `db:"channel_id"`
Roles pq.Int64Array `db:"roles"`
}
type ChannelRolesPermission ¶
type ChannelType ¶
type ChannelType int
const ( ChannelTypeGuild ChannelType = iota // Default text channel in guild ChannelTypeGuildVoice // Voice channel in guild ChannelTypeGuildCategory // Category channel in guild ChannelTypeDM // DM channel. Can't be created in Guild ChannelTypeGroupDM // Group DM channel. Can't be created in Guild' ChannelTypeThread // Thread channel )
type ChannelUserPermission ¶
type Devices ¶ added in v1.5.0
type Devices struct {
AudioInputDevice string `json:"audio_input_device"`
AudioOutputDevice string `json:"audio_output_device"`
VideoDevice string `json:"video_device"`
NoiseSuppression bool `json:"noise_suppression"`
DenoiserType string `json:"denoiser_type"`
EchoCancellation bool `json:"echo_cancellation"`
AudioInputLevel float64 `json:"audio_input_level"`
AudioOutputLevel float64 `json:"audio_output_level"`
AudioInputThreshold float64 `json:"audio_input_threshold"`
AutoGainControl bool `json:"auto_gain_control"`
}
type Discriminator ¶
type EmojiLookup ¶ added in v1.7.0
type FriendRequest ¶ added in v1.5.0
type GroupDMChannel ¶
type GuildChannel ¶
type GuildEmoji ¶ added in v1.7.0
type GuildEmoji struct {
GuildId int64 `db:"guild_id"`
Id int64 `db:"id"`
Name string `db:"name"`
NameNormalized string `db:"name_normalized"`
CreatorId int64 `db:"creator_id"`
Done bool `db:"done"`
Animated bool `db:"animated"`
DeclaredFileSize int64 `db:"declared_file_size"`
ActualFileSize *int64 `db:"actual_file_size"`
ContentType *string `db:"content_type"`
Width *int64 `db:"width"`
Height *int64 `db:"height"`
UploadExpiresAt time.Time `db:"upload_expires_at"`
CreatedAt time.Time `db:"created_at"`
UpdatedAt time.Time `db:"updated_at"`
}
type GuildInvite ¶
type GuildInvite struct {
InviteCode string `db:"invite_code"`
InviteId int64 `db:"invite_id"`
GuildId int64 `db:"guild_id"`
AuthorId int64 `db:"author_id"`
CreatedAt time.Time `db:"created_at"`
ExpiresAt time.Time `db:"expires_at"`
}
GuildInvite represents an invite joined with its code and metadata
type MessageType ¶
type MessageType int
const ( MessageTypeChat MessageType = iota MessageTypeReply MessageTypeJoin MessageTypeThreadCreated MessageTypeThreadInitial )
type NotificationsType ¶ added in v1.4.0
type NotificationsType int
const ( NotificationsAll NotificationsType = iota NotificationsMentions NotificationsNone )
type ReactionSummary ¶ added in v1.10.0
type Registration ¶
type RoleUpdatePosition ¶ added in v1.7.0
type Status ¶ added in v1.5.0
type ThreadMember ¶ added in v1.8.0
type User ¶
type User struct {
Id int64 `json:"id" db:"id"`
Name string `json:"name" db:"name"`
Bio *string `json:"bio" db:"bio"`
BannerColor *int `json:"banner_color" db:"banner_color"`
PanelColor *int `json:"panel_color" db:"panel_color"`
Avatar *int64 `json:"avatar" db:"avatar"`
Blocked bool `json:"blocked" db:"blocked"`
UploadLimit *int64 `json:"upload_limit" db:"upload_limit"`
CreatedAt time.Time `json:"created_at" db:"created_at"`
}
type UserDMChannels ¶ added in v1.5.0
type UserDMChannels struct {
UserId helper.StringInt64 `json:"user_id"`
ChannelId helper.StringInt64 `json:"channel_id"`
Hidden bool `json:"hidden"`
HiddenAfter int64 `json:"hidden_after"`
}
type UserRoles ¶ added in v1.4.0
type UserRoles struct {
UserId int64 `db:"user_id"`
Roles pq.Int64Array `db:"roles"`
}
type UserSettings ¶ added in v1.4.0
type UserSettings struct {
UserId int64 `db:"user_id,string"`
Settings json.RawMessage `db:"settings"`
Version int64 `db:"version,string"`
}
type UserSettingsAppearance ¶ added in v1.4.0
type UserSettingsChannel ¶ added in v1.5.0
type UserSettingsChannel struct {
ChannelId helper.StringInt64 `json:"channel_id"`
Notifications UserSettingsNotifications `json:"notifications"`
}
type UserSettingsData ¶ added in v1.4.0
type UserSettingsData struct {
Language string `json:"language"`
Appearance UserSettingsAppearance `json:"appearance"`
GuildFolders []UserSettingsGuildFolders `json:"guild_folders"`
Guilds []UserSettingsGuilds `json:"guilds"`
ChannelsSettings []UserSettingsChannel `json:"channels"`
UsersSettings []UserSettingsUsers `json:"users"`
FavoriteGifs []string `json:"favorite_gifs"`
ForcedPresence string `json:"forced_presence"`
Status Status `json:"status"`
DMChannels []UserDMChannels `json:"dm_channels"`
Devices Devices `json:"devices"`
DevicesByKey map[string]Devices `json:"devices_by_key,omitempty"`
UISounds UserUISounds `json:"ui_sounds"`
// contains filtered or unexported fields
}
func UnmarshalStoredUserSettingsData ¶ added in v1.11.0
func UnmarshalStoredUserSettingsData(data []byte) (UserSettingsData, error)
func (UserSettingsData) DeviceUsageOrder ¶ added in v1.11.0
func (s UserSettingsData) DeviceUsageOrder() []string
func (UserSettingsData) DevicesForKey ¶ added in v1.11.0
func (s UserSettingsData) DevicesForKey(deviceKey string) Devices
func (*UserSettingsData) NormalizeCollections ¶ added in v1.10.0
func (s *UserSettingsData) NormalizeCollections()
func (*UserSettingsData) SetDeviceUsageOrder ¶ added in v1.11.0
func (s *UserSettingsData) SetDeviceUsageOrder(order []string)
func (*UserSettingsData) SetDevicesForKey ¶ added in v1.11.0
func (s *UserSettingsData) SetDevicesForKey(deviceKey string, devices Devices)
func (UserSettingsData) Validate ¶ added in v1.4.0
func (s UserSettingsData) Validate() error
type UserSettingsGuildFolders ¶ added in v1.4.0
type UserSettingsGuildFolders struct {
Name string `json:"name"`
Color int64 `json:"color"`
Position int64 `json:"position"`
Guilds helper.StringInt64Array `json:"guilds"`
}
type UserSettingsGuilds ¶ added in v1.4.0
type UserSettingsGuilds struct {
GuildId helper.StringInt64 `json:"guild_id"`
Position int64 `json:"position"`
SelectedChannel helper.StringInt64 `json:"selected_channel"`
Notifications UserSettingsNotifications `json:"notifications"`
}
func (UserSettingsGuilds) Validate ¶ added in v1.4.0
func (g UserSettingsGuilds) Validate() error
type UserSettingsNotifications ¶ added in v1.4.0
type UserSettingsNotifications struct {
Muted bool `json:"muted"`
MutedUntil *time.Time `json:"muted_until,omitempty"`
Notifications NotificationsType `json:"notifications"`
SuppressUserMentions bool `json:"suppress_user_mentions"`
SuppressRoleMentions bool `json:"suppress_role_mentions"`
SuppressEveryoneMentions bool `json:"suppress_everyone_mentions"`
SuppressHereMentions bool `json:"suppress_here_mentions"`
}
func (UserSettingsNotifications) Validate ¶ added in v1.4.0
func (n UserSettingsNotifications) Validate() error
type UserSettingsUsers ¶ added in v1.5.0
type UserSettingsUsers struct {
UserId helper.StringInt64 `json:"user_id"`
Notifications UserSettingsNotifications `json:"notifications"`
}
Source Files
¶
- attachment.go
- audit.go
- auth_factor.go
- authentication.go
- avatar.go
- channel.go
- channel_roles_perm.go
- channel_user_perm.go
- discriminator.go
- dm_channel.go
- emoji.go
- friend.go
- friend_request.go
- group_dm_channel.go
- guild.go
- guild_ban.go
- guild_channel.go
- icon.go
- invite.go
- member.go
- mention.go
- message.go
- reaction.go
- registration.go
- role.go
- thread_member.go
- user.go
- user_role.go
- user_settings.go
- user_settings_storage.go
Click to show internal directories.
Click to hide internal directories.