discord

Documentation

Index

• type Embed
• type Payload
• type Provider
  • func (p *Provider) Enabled() bool
  • func (*Provider) GetName() string
  • func (p *Provider) Notify(news news.Announcements)

Types

type Embed

type Embed struct {
	Description string `json:"description"`
	Color       string `json:"color"`
}

Embed is a custom field for a Discord webhook payload.

type Payload

type Payload struct {
	Username  string  `json:"username"`
	AvatarURL string  `json:"avatar_url"`
	Embeds    []Embed `json:"embeds"`
}

Payload is the json sent to the Discord webhook endpoint.

type Provider

type Provider struct {
	WebhookURL string `yaml:"webhookURL"`
	AvatarURL  string `yaml:"avatarURL"`
	IsEnabled  bool   `yaml:"enabled"`
}

Provider is an implementation of the `go-aws-news/providers` Provider interface.

func (*Provider) Enabled

func (p *Provider) Enabled() bool

Enabled returns true if the provider is enabled in the config.

func (*Provider) GetName

func (*Provider) GetName() string

GetName returns the Provider's name.

func (*Provider) Notify

func (p *Provider) Notify(news news.Announcements)

Notify is the function executed to POST to a provider's webhook url.