api

package

Go to main page

Versions in this module

v1

v1.4.4

Sep 24, 2021

v1.4.3

Aug 3, 2021

v1.4.2

Jul 30, 2021

v1.4.1

Jul 30, 2021

v1.4.0

Jul 4, 2021

Changes in this version

+ const ComponentTypeSelectMenu

type ActionRow

+ func (r ActionRow) AddComponents(components ...Component) ActionRow

+ func (r ActionRow) RemoveComponent(index int) ActionRow

+ func (r ActionRow) SetComponent(customID string, component Component) ActionRow

+ func (r ActionRow) SetComponents(components ...Component) ActionRow

type Button

+ func (b Button) AsDisabled() Button

+ func (b Button) AsEnabled() Button

+ func (b Button) WithCustomID(customID string) Button

+ func (b Button) WithDisabled(disabled bool) Button

+ func (b Button) WithEmoji(emoji *Emoji) Button

+ func (b Button) WithLabel(label string) Button

+ func (b Button) WithStyle(style ButtonStyle) Button

+ func (b Button) WithURL(url string) Button

+ type SelectMenu struct

+ CustomID string

+ MaxValues int

+ MinValues int

+ Options []SelectOption

+ Placeholder string

+ func NewSelectMenu(customID string, placeholder string, minValues int, maxValues int, ...) SelectMenu

+ func (m SelectMenu) AddOptions(options ...SelectOption) SelectMenu

+ func (m SelectMenu) RemoveOption(index int) SelectMenu

+ func (m SelectMenu) SetOption(value string, option SelectOption) SelectMenu

+ func (m SelectMenu) SetOptions(options ...SelectOption) SelectMenu

+ func (m SelectMenu) WithCustomID(customID string) SelectMenu

+ func (m SelectMenu) WithMaxValues(maxValue int) SelectMenu

+ func (m SelectMenu) WithMinValues(minValue int) SelectMenu

+ func (m SelectMenu) WithPlaceholder(placeholder string) SelectMenu

+ type SelectOption struct

+ Default bool

+ Description string

+ Emoji *Emoji

+ Label string

+ Value string

+ func NewSelectOption(label string, value string) SelectOption

+ func (o SelectOption) WithDefault(defaultOption bool) SelectOption

+ func (o SelectOption) WithDescription(description string) SelectOption

+ func (o SelectOption) WithEmoji(emoji *Emoji) SelectOption

+ func (o SelectOption) WithLabel(label string) SelectOption

+ func (o SelectOption) WithValue(value string) SelectOption

type UnmarshalComponent

+ MaxValues int

+ MinValues int

+ Options []SelectOption

+ Placeholder string

type WebhookClient

+ EditEmbeds func(messageID Snowflake, embeds ...Embed) (*WebhookMessage, restclient.RestError)

+ SendEmbeds func(embeds ...Embed) (*WebhookMessage, restclient.RestError)

type WebhookMessage

+ func (m *WebhookMessage) ActionRows() []ActionRow

+ func (m *WebhookMessage) ButtonByID(customID string) *Button

+ func (m *WebhookMessage) Buttons() []Button

+ func (m *WebhookMessage) ComponentByID(customID string) Component

+ func (m *WebhookMessage) Marshal() ([]byte, error)

+ func (m *WebhookMessage) SelectMenuByID(customID string) *SelectMenu

+ func (m *WebhookMessage) SelectMenus() []SelectMenu

+ func (m *WebhookMessage) Unmarshal(data []byte) error

v1.3.0

Jun 15, 2021

v1.2.1

Jun 12, 2021

Changes in this version

+ const Github

+ var Version = getVersion()

+ var WebhookURLPattern = regexp.MustCompile(...)

+ type Attachment struct

+ Filename string

+ Height *int

+ ID Snowflake

+ ProxyURL string

+ Size int

+ URL string

+ Width *int

+ type FullWebhookMessage struct

+ UnmarshalComponents []UnmarshalComponent

type WebhookMessage

+ Components []Component

type WebhookMessageCreate

+ Files []restclient.File

+ func (m WebhookMessageCreate) ToBody() (interface{}, error)

type WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) AddFile(name string, reader io.Reader, flags ...restclient.FileFlags) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) AddFiles(files ...restclient.File) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) ClearFiles() *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) RemoveFiles(i int) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetFiles(files ...restclient.File) *WebhookMessageCreateBuilder

type WebhookMessageUpdate

+ Attachments []Attachment

+ Files []restclient.File

+ func (m WebhookMessageUpdate) ToBody() (interface{}, error)

type WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) AddFile(name string, reader io.Reader, flags ...restclient.FileFlags) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) AddFiles(files ...restclient.File) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) ClearFiles() *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) RemoveFiles(i int) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) RetainAttachments(attachments ...Attachment) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) RetainAttachmentsByID(attachmentIDs ...Snowflake) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetFiles(files ...restclient.File) *WebhookMessageUpdateBuilder

v1.2.0

Jun 7, 2021

Changes in this version

+ const ButtonStyleDanger

+ const ButtonStyleLink

+ const ButtonStylePrimary

+ const ButtonStyleSecondary

+ const ButtonStyleSuccess

+ const ComponentTypeActionRow

+ const ComponentTypeButton

+ type ActionRow struct

+ Components []Component

+ func NewActionRow(components ...Component) ActionRow

+ type Button struct

+ CustomID string

+ Disabled bool

+ Emoji *Emoji

+ Label *string

+ Style ButtonStyle

+ URL string

+ func NewButton(style ButtonStyle, label *string, customID string, url string, emoji *Emoji, ...) Button

+ func NewDangerButton(label string, customID string, emoji *Emoji, disabled bool) Button

+ func NewLinkButton(label string, url string, emoji *Emoji, disabled bool) Button

+ func NewPrimaryButton(label string, customID string, emoji *Emoji, disabled bool) Button

+ func NewSecondaryButton(label string, customID string, emoji *Emoji, disabled bool) Button

+ func NewSuccessButton(label string, customID string, emoji *Emoji, disabled bool) Button

+ type ButtonStyle int

+ type Component interface

+ Type func() ComponentType

+ type ComponentImpl struct

+ ComponentType ComponentType

+ func (t ComponentImpl) Type() ComponentType

+ type ComponentType int

+ type Emoji struct

+ Animated bool

+ ID Snowflake

+ Name string

+ func NewEmoji(name string) *Emoji

+ func NewEmote(name string, emoteID Snowflake, animated bool) *Emoji

+ type MessageFlags int64

+ const MessageFlagCrossposted

+ const MessageFlagEphemeral

+ const MessageFlagIsCrosspost

+ const MessageFlagLoading

+ const MessageFlagNone

+ const MessageFlagSourceMessageDeleted

+ const MessageFlagSuppressEmbeds

+ const MessageFlagUrgent

+ func (f MessageFlags) Add(bits ...MessageFlags) MessageFlags

+ func (f MessageFlags) Has(bit MessageFlags) bool

+ func (f MessageFlags) HasAll(bits ...MessageFlags) bool

+ func (f MessageFlags) Missing(bit MessageFlags) bool

+ func (f MessageFlags) MissingAny(bits ...MessageFlags) bool

+ func (f MessageFlags) Remove(bits ...MessageFlags) MessageFlags

type RestClient

+ WebhookClient func() WebhookClient

+ type UnmarshalComponent struct

+ ComponentType ComponentType

+ Components []UnmarshalComponent

+ CustomID string

+ Disabled bool

+ Emoji *Emoji

+ Label *string

+ Style ButtonStyle

+ URL string

type WebhookMessageCreate

+ Components []Component

+ Flags MessageFlags

+ type WebhookMessageCreateBuilder struct

+ func NewWebhookMessageCreateBuilder() *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) AddComponents(components ...Component) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) AddEmbeds(embeds ...Embed) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) Build() WebhookMessageCreate

+ func (b *WebhookMessageCreateBuilder) ClearEmbeds() *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) RemoveEmbed(index int) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetAllowedMentions(allowedMentions *AllowedMentions) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetAllowedMentionsEmpty() *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetComponents(components ...Component) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetContent(content string) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetContentf(content string, a ...interface{}) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetEmbeds(embeds ...Embed) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetEphemeral(ephemeral bool) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetFlags(flags MessageFlags) *WebhookMessageCreateBuilder

+ func (b *WebhookMessageCreateBuilder) SetTTS(tts bool) *WebhookMessageCreateBuilder

type WebhookMessageUpdate

+ Components []Component

+ Flags MessageFlags

+ func (u WebhookMessageUpdate) MarshalJSON() ([]byte, error)

+ type WebhookMessageUpdateBuilder struct

+ func NewWebhookMessageUpdateBuilder() *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) AddComponents(components ...Component) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) AddEmbeds(embeds ...Embed) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) Build() WebhookMessageUpdate

+ func (b *WebhookMessageUpdateBuilder) ClearAllowedMentions() *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) ClearComponents() *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) ClearEmbeds() *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) RemoveComponent(i int) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) RemoveEmbed(index int) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetAllowedMentions(allowedMentions *AllowedMentions) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetComponents(components ...Component) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetContent(content string) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetContentf(content string, a ...interface{}) *WebhookMessageUpdateBuilder

+ func (b *WebhookMessageUpdateBuilder) SetEmbeds(embeds ...Embed) *WebhookMessageUpdateBuilder

v1.1.1

May 25, 2021

v1.1.0

May 25, 2021

Changes in this version

+ type DeconstructedSnowflake struct

+ Binary string

+ Increment int64

+ ProcessID int64

+ Timestamp int64

+ WorkerID int64

type RestClient

+ DeleteWebhook func(webhookID Snowflake, webhookToken string) error

+ GetWebhook func(webhookID Snowflake, webhookToken string) (*Webhook, error)

+ UpdateWebhook func(webhookID Snowflake, webhookToken string, webhookUpdate *WebhookUpdate) (*Webhook, error)

+ type Snowflake string

+ func (s Snowflake) Binary() string

+ func (s Snowflake) Deconstruct() DeconstructedSnowflake

+ func (s Snowflake) String() string

+ func (s Snowflake) Timestamp() time.Time

type Webhook

+ ApplicationID Snowflake

+ Avatar string

+ ChannelID *Snowflake

+ GuildID *Snowflake

+ Name string

+ Type WebhookType

+ type WebhookClient interface

+ DefaultAllowedMentions func() *AllowedMentions

+ DeleteMessage func(id Snowflake) error

+ DeleteWebhook func() error

+ EditContent func(messageID Snowflake, content string) (*WebhookMessage, error)

+ EditEmbed func(messageID Snowflake, embed *Embed, embeds ...*Embed) (*WebhookMessage, error)

+ EditMessage func(messageID Snowflake, message *WebhookMessageUpdate) (*WebhookMessage, error)

+ EditWebhook func(webhookUpdate *WebhookUpdate) (*Webhook, error)

+ GetWebhook func() (*Webhook, error)

+ ID func() Snowflake

+ Logger func() log.Logger

+ RestClient func() RestClient

+ SendContent func(content string) (*WebhookMessage, error)

+ SendEmbed func(embed *Embed, embeds ...*Embed) (*WebhookMessage, error)

+ SendMessage func(message *WebhookMessageCreate) (*WebhookMessage, error)

+ SetDefaultAllowedMentions func(allowedMentions *AllowedMentions)

+ Token func() string

+ URL func() string

+ type WebhookType int

+ const WebhookTypeApplication

+ const WebhookTypeChannelFollower

+ const WebhookTypeIncoming

+ type WebhookUpdate struct

+ Avatar io.Reader

+ Name *string

v1.0.4

Apr 23, 2021

Changes in this version

type EmbedBuilder

+ func (b *EmbedBuilder) SetAuthorIcon(iconURL string) *EmbedBuilder

+ func (b *EmbedBuilder) SetAuthorName(name string) *EmbedBuilder

+ func (b *EmbedBuilder) SetAuthorURL(url string) *EmbedBuilder

+ func (b *EmbedBuilder) SetEmbedFooter(footer *EmbedFooter) *EmbedBuilder

+ func (b *EmbedBuilder) SetFooterIcon(iconURL string) *EmbedBuilder

+ func (b *EmbedBuilder) SetFooterText(text string) *EmbedBuilder

+ func (b *EmbedBuilder) SetTitlef(title string, a ...interface{}) *EmbedBuilder

type WebhookMessage

+ EditedAt *time.Time

+ func (m *WebhookMessage) Delete() error

+ func (m *WebhookMessage) Edit(message *WebhookMessageUpdate) (*WebhookMessage, error)

type WebhookMessageBuilder

+ func NewWebhookMessageBuilderWithContent(content string) *WebhookMessageBuilder

+ func NewWebhookMessageBuilderWithEmbeds(embed *Embed, embeds ...*Embed) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) ClearAllowedMentions() *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetContentf(content string, a ...interface{}) *WebhookMessageBuilder

v1.0.3

Apr 23, 2021

v1.0.2

Apr 23, 2021

v1.0.1

Apr 23, 2021

v1.0.0

Apr 23, 2021

Changes in this version

+ var DefaultAllowedMentions = AllowedMentions

+ var ErrBadGateway = errors.New("bad gateway could not reach discord")

+ var ErrBadRequest = errors.New("bad request please check your request")

+ var ErrMalformedWebhookToken = errors.New("malformed webhook token <id>/<token>")

+ var ErrRatelimited = errors.New("too many requests")

+ var ErrUnauthorized = errors.New("not authorized for this endpoint")

+ var WebhookPattern = regexp.MustCompile(...)

+ type AllowedMentionType string

+ const AllowedMentionTypeEveryone

+ const AllowedMentionTypeRoles

+ const AllowedMentionTypeUsers

+ type AllowedMentions struct

+ Parse []AllowedMentionType

+ RepliedUser bool

+ Roles []string

+ Users []string

+ type Channel struct

+ type Embed struct

+ Author *EmbedAuthor

+ Color *int

+ Description *string

+ Fields []*EmbedField

+ Footer *EmbedFooter

+ Image *EmbedResource

+ Provider *EmbedProvider

+ Thumbnail *EmbedResource

+ Timestamp *time.Time

+ Title *string

+ Type *EmbedType

+ URL *string

+ Video *EmbedResource

+ type EmbedAuthor struct

+ IconURL *string

+ Name *string

+ ProxyIconURL *string

+ URL *string

+ type EmbedBuilder struct

+ func NewEmbedBuilder() *EmbedBuilder

+ func (b *EmbedBuilder) AddField(name string, value string, inline bool) *EmbedBuilder

+ func (b *EmbedBuilder) AddFields(f *EmbedField, fs ...*EmbedField) *EmbedBuilder

+ func (b *EmbedBuilder) Build() Embed

+ func (b *EmbedBuilder) ClearFields() *EmbedBuilder

+ func (b *EmbedBuilder) RemoveField(index int) *EmbedBuilder

+ func (b *EmbedBuilder) SetAuthor(name string, url string) *EmbedBuilder

+ func (b *EmbedBuilder) SetAuthorI(name string, url string, iconURL string) *EmbedBuilder

+ func (b *EmbedBuilder) SetColor(color int) *EmbedBuilder

+ func (b *EmbedBuilder) SetDescription(description string) *EmbedBuilder

+ func (b *EmbedBuilder) SetDescriptionf(description string, a ...interface{}) *EmbedBuilder

+ func (b *EmbedBuilder) SetEmbedAuthor(author *EmbedAuthor) *EmbedBuilder

+ func (b *EmbedBuilder) SetField(index int, name string, value string, inline bool) *EmbedBuilder

+ func (b *EmbedBuilder) SetFields(fs ...*EmbedField) *EmbedBuilder

+ func (b *EmbedBuilder) SetFooter(footer *EmbedFooter) *EmbedBuilder

+ func (b *EmbedBuilder) SetFooterBy(text string, iconURL string) *EmbedBuilder

+ func (b *EmbedBuilder) SetImage(i *string) *EmbedBuilder

+ func (b *EmbedBuilder) SetThumbnail(i *string) *EmbedBuilder

+ func (b *EmbedBuilder) SetTitle(title string) *EmbedBuilder

+ func (b *EmbedBuilder) SetURL(url string) *EmbedBuilder

+ type EmbedField struct

+ Inline *bool

+ Name string

+ Value string

+ type EmbedFooter struct

+ IconURL *string

+ ProxyIconURL *string

+ Text string

+ type EmbedProvider struct

+ Name *string

+ URL *string

+ type EmbedResource struct

+ Height *int

+ ProxyURL *string

+ URL *string

+ Width *int

+ type EmbedType string

+ const EmbedTypeArticle

+ const EmbedTypeGifV

+ const EmbedTypeImage

+ const EmbedTypeLink

+ const EmbedTypeRich

+ const EmbedTypeVideo

+ type ErrorResponse struct

+ Code int

+ Message string

+ type Guild struct

+ type Member struct

+ Deaf *bool

+ GuildID string

+ JoinedAt time.Time

+ Mute *bool

+ Nick *string

+ Pending bool

+ PremiumSince *time.Time

+ Roles []string

+ User *User

+ type RestClient interface

+ CreateWebhookMessage func(webhookID string, webhookToken string, message WebhookMessageCreate) (*WebhookMessage, error)

+ DeleteWebhookMessage func(webhookID string, webhookToken string, messageID string) error

+ Request func(route endpoints.CompiledAPIRoute, rqBody interface{}, rsBody interface{}) error

+ UpdateWebhookMessage func(webhookID string, webhookToken string, messageID string, ...) (*WebhookMessage, error)

+ UserAgent func() string

+ type User struct

+ Avatar *string

+ Bot *bool

+ Discriminator string

+ ID string

+ Username string

+ func (u *User) AvatarURL() string

+ func (u User) Mention() string

+ func (u User) String() string

+ func (u User) Tag() string

+ type Webhook interface

+ DefaultAllowedMentions func() *AllowedMentions

+ DeleteMessage func(id string) error

+ EditContent func(messageID string, content string) (*WebhookMessage, error)

+ EditEmbed func(messageID string, embed *Embed, embeds ...*Embed) (*WebhookMessage, error)

+ EditMessage func(messageID string, message WebhookMessageUpdate) (*WebhookMessage, error)

+ ID func() string

+ Logger func() log.Logger

+ RestClient func() RestClient

+ SendContent func(content string) (*WebhookMessage, error)

+ SendEmbed func(embed *Embed, embeds ...*Embed) (*WebhookMessage, error)

+ SendMessage func(message WebhookMessageCreate) (*WebhookMessage, error)

+ SetDefaultAllowedMentions func(allowedMentions *AllowedMentions)

+ Token func() string

+ URL func() string

+ type WebhookAttachment struct

+ Filename string

+ Height *int

+ ID string

+ ProxyURL string

+ Size int

+ URL string

+ Width *int

+ type WebhookMessage struct

+ Attachments []*WebhookAttachment

+ Author *User

+ ChannelID string

+ Content *string

+ CreatedAt time.Time

+ Embeds []*Embed

+ GuildID string

+ ID string

+ Member *Member

+ MentionChannels []*Channel

+ MentionEveryone bool

+ MentionRoles []string

+ Mentions []interface{}

+ TTS bool

+ Webhook Webhook

+ WebhookID string

+ type WebhookMessageBuilder struct

+ func NewWebhookMessageBuilder() *WebhookMessageBuilder

+ func NewWebhookMessageWithContent(content string) *WebhookMessageBuilder

+ func NewWebhookMessageWithEmbeds(embed *Embed, embeds ...*Embed) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) AddEmbeds(embeds ...*Embed) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) Build() WebhookMessageCreate

+ func (b *WebhookMessageBuilder) ClearEmbeds() *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) RemoveEmbed(index int) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetAllowedMentions(allowedMentions *AllowedMentions) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetAllowedMentionsEmpty() *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetContent(content string) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetEmbeds(embeds ...*Embed) *WebhookMessageBuilder

+ func (b *WebhookMessageBuilder) SetTTS(tts bool) *WebhookMessageBuilder

+ type WebhookMessageCreate struct

+ AllowedMentions *AllowedMentions

+ AvatarURL string

+ Content string

+ Embeds []*Embed

+ TTS bool

+ Username string

+ type WebhookMessageUpdate struct

+ AllowedMentions *AllowedMentions

+ Content string

+ Embeds []*Embed

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL