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

123 lines
4.2 KiB
Go
Raw Normal View History

package discord
2020-05-23 16:01:08 +00:00
// https://discord.com/developers/docs/resources/channel#channel-object
type Channel struct {
2020-05-23 16:01:08 +00:00
// ID is the id of this channel.
ID ChannelID `json:"id,string"`
2020-05-23 16:01:08 +00:00
// Type is the type of channel.
Type ChannelType `json:"type"`
2020-05-23 16:01:08 +00:00
// GuildID is the id of the guild.
GuildID GuildID `json:"guild_id,string,omitempty"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// AppID is the application id of the group DM creator if it is
// bot-created.
AppID AppID `json:"application_id,string,omitempty"`
2020-05-23 16:01:08 +00:00
// 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"`
2020-05-23 16:01:08 +00:00
// LastPinTime is when the last pinned message was pinned.
LastPinTime Timestamp `json:"last_pin_timestamp,omitempty"`
}
2020-05-23 16:01:08 +00:00
// Mention returns a mention of the channel.
2020-01-24 05:45:47 +00:00
func (ch Channel) Mention() string {
return ch.ID.Mention()
2020-01-24 05:45:47 +00:00
}
2020-05-23 16:01:08 +00:00
// IconURL returns the URL to the channel icon in the PNG format.
// An empty string is returned if there's no icon.
2020-03-05 23:49:44 +00:00
func (ch Channel) IconURL() string {
2020-05-23 16:01:08 +00:00
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 {
2020-03-05 23:49:44 +00:00
if ch.Icon == "" {
return ""
}
return "https://cdn.discordapp.com/channel-icons/" +
2020-05-23 16:01:08 +00:00
ch.ID.String() + "/" + t.format(ch.Icon)
2020-03-05 23:49:44 +00:00
}
type ChannelType uint8
2020-05-23 16:01:08 +00:00
// https://discord.com/developers/docs/resources/channel#channel-object-channel-types
2020-05-11 02:30:34 +00:00
var (
2020-05-23 16:01:08 +00:00
// GuildText is a text channel within a server.
GuildText ChannelType = 0
// DirectMessage is a direct message between users.
2020-05-11 02:30:34 +00:00
DirectMessage ChannelType = 1
2020-05-23 16:01:08 +00:00
// 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.
2020-05-11 02:30:34 +00:00
GuildCategory ChannelType = 4
2020-05-23 16:01:08 +00:00
// 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
)
2020-05-23 16:01:08 +00:00
// https://discord.com/developers/docs/resources/channel#overwrite-object
type Overwrite struct {
2020-05-23 16:01:08 +00:00
// ID is the role or user id.
ID Snowflake `json:"id"`
2020-05-23 16:01:08 +00:00
// Type is either "role" or "member".
Type OverwriteType `json:"type,string"`
2020-05-23 16:01:08 +00:00
// Allow is a permission bit set for granted permissions.
Allow Permissions `json:"allow,string"`
2020-05-23 16:01:08 +00:00
// Deny is a permission bit set for denied permissions.
Deny Permissions `json:"deny,string"`
}
type OverwriteType uint8
const (
2020-05-23 16:01:08 +00:00
// OverwriteRole is an overwrite for a role.
OverwriteRole OverwriteType = iota
2020-05-23 16:01:08 +00:00
// OverwriteMember is an overwrite for a member.
OverwriteMember
)