1
0
Fork 0
mirror of https://github.com/diamondburned/arikawa.git synced 2024-12-11 16:05:00 +00:00
arikawa/discord/channel.go
Maximilian von Lindern 607250ae55
Gateway: Added reconnect timeout; fixed UA (#154)
* Gateway: use gateway version 8

* API: remove old v0.0.1 version tag

* Discord: fix typos

* Gateway: add timeout

* Gateway: revert to returning errors on ReconnectCtx
2020-10-30 13:41:04 -07:00

145 lines
4.7 KiB
Go

package discord
import (
"bytes"
"strconv"
)
// https://discord.com/developers/docs/resources/channel#channel-object
type Channel struct {
// ID is the id of this channel.
ID ChannelID `json:"id,string"`
// Type is the type of channel.
Type ChannelType `json:"type"`
// GuildID is the id of the guild.
GuildID GuildID `json:"guild_id,string,omitempty"`
// Position is the sorting position of the channel.
Position int `json:"position,omitempty"`
// Permissions are the explicit permission overrides for members and roles.
Permissions []Overwrite `json:"permission_overwrites,omitempty"`
// Name is the name of the channel (2-100 characters).
Name string `json:"name,omitempty"`
// Topic is the channel topic (0-1024 characters).
Topic string `json:"topic,omitempty"`
// NSFW specifies whether the channel is nsfw.
NSFW bool `json:"nsfw"`
// LastMessageID is the id of the last message sent in this channel (may
// not point to an existing or valid message).
LastMessageID MessageID `json:"last_message_id,string,omitempty"`
// VoiceBitrate is the bitrate (in bits) of the voice channel.
VoiceBitrate uint `json:"bitrate,omitempty"`
// VoiceUserLimit is the user limit of the voice channel.
VoiceUserLimit uint `json:"user_limit,omitempty"`
// UserRateLimit is the 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.
UserRateLimit Seconds `json:"rate_limit_per_user,omitempty"`
// DMRecipients are the recipients of the DM.
DMRecipients []User `json:"recipients,omitempty"`
// Icon is the icon hash.
Icon Hash `json:"icon,omitempty"`
// DMOwnerID is the id of the DM creator.
DMOwnerID UserID `json:"owner_id,string,omitempty"`
// AppID is the application id of the group DM creator if it is
// bot-created.
AppID AppID `json:"application_id,string,omitempty"`
// CategoryID is the id of the parent category for a channel (each parent
// category can contain up to 50 channels).
CategoryID ChannelID `json:"parent_id,string,omitempty"`
// LastPinTime is when the last pinned message was pinned.
LastPinTime Timestamp `json:"last_pin_timestamp,omitempty"`
}
// Mention returns a mention of the channel.
func (ch Channel) Mention() string {
return ch.ID.Mention()
}
// IconURL returns the URL to the channel icon in the PNG format.
// An empty string is returned if there's no icon.
func (ch Channel) IconURL() string {
return ch.IconURLWithType(PNGImage)
}
// IconURLWithType returns the URL to the channel icon using the passed
// ImageType. An empty string is returned if there's no icon.
//
// Supported ImageTypes: PNG, JPEG, WebP
func (ch Channel) IconURLWithType(t ImageType) string {
if ch.Icon == "" {
return ""
}
return "https://cdn.discordapp.com/channel-icons/" +
ch.ID.String() + "/" + t.format(ch.Icon)
}
type ChannelType uint8
// https://discord.com/developers/docs/resources/channel#channel-object-channel-types
var (
// GuildText is a text channel within a server.
GuildText ChannelType = 0
// DirectMessage is a direct message between users.
DirectMessage ChannelType = 1
// GuildVoice is a voice channel within a server.
GuildVoice ChannelType = 2
// GroupDM is a direct message between multiple users.
GroupDM ChannelType = 3
// GuildCategory is an organizational category that contains up to 50
// channels.
GuildCategory ChannelType = 4
// GuildNews is a channel that users can follow and crosspost into their
// own server.
GuildNews ChannelType = 5
// GuildStore is a channel in which game developers can sell their game on
// Discord.
GuildStore ChannelType = 6
)
// https://discord.com/developers/docs/resources/channel#overwrite-object
type Overwrite struct {
// ID is the role or user id.
ID Snowflake `json:"id"`
// Type indicates the entity overwritten: role or member.
Type OverwriteType `json:"type"`
// Allow is a permission bit set for granted permissions.
Allow Permissions `json:"allow,string"`
// Deny is a permission bit set for denied permissions.
Deny Permissions `json:"deny,string"`
}
// OverwriteType is an enumerated type to indicate the entity being overwritten:
// role or member
type OverwriteType uint8
const (
// OverwriteRole is an overwrite for a role.
OverwriteRole OverwriteType = iota
// OverwriteMember is an overwrite for a member.
OverwriteMember
)
// UnmarshalJSON unmarshalls both a string-quoted number and a regular number
// into OverwriteType. We need to do this because Discord is so bad that they
// can't even handle 1s and 0s properly.
func (otype *OverwriteType) UnmarshalJSON(b []byte) error {
b = bytes.Trim(b, `"`)
u, err := strconv.ParseUint(string(b), 10, 8)
if err != nil {
return err
}
*otype = OverwriteType(u)
return nil
}