discord

Documentation

Index

• Constants
• func CreateAPIURLFromConfig(config *Config) string
• func CreateJSONToSend(message string) ([]byte, error)
• type Config
  • func (config *Config) GetURL() *url.URL
  • func (config *Config) SetURL(url *url.URL) error
• type JSON
• type Service
  • func (service *Service) Initialize(configURL *url.URL, logger *log.Logger) error
  • func (service *Service) Send(message string, params *types.Params) error

Constants

const Scheme = "discord"

Scheme is the identifying part of this service's configuration URL

Functions

func CreateAPIURLFromConfig

func CreateAPIURLFromConfig(config *Config) string

CreateAPIURLFromConfig takes a discord config object and creates a post url

func CreateJSONToSend

func CreateJSONToSend(message string) ([]byte, error)

CreateJSONToSend creates a JSON payload to be sent to the discord webhook API

Types

type Config

type Config struct {
	standard.QuerylessConfig
	standard.EnumlessConfig
	Channel string
	Token   string
}

Config is the configuration needed to send discord notifications

func (*Config) GetURL

func (config *Config) GetURL() *url.URL

GetURL returns a URL representation of it's current field values

func (*Config) SetURL

func (config *Config) SetURL(url *url.URL) error

SetURL updates a ServiceConfig from a URL representation of it's field values

type JSON

type JSON struct {
	Text string `json:"content"`
}

JSON is the actual notification payload

type Service

type Service struct {
	standard.Standard
	// contains filtered or unexported fields
}

Service providing Discord as a notification service

func (*Service) Initialize

func (service *Service) Initialize(configURL *url.URL, logger *log.Logger) error

Initialize loads ServiceConfig from configURL and sets logger for this Service

func (*Service) Send

func (service *Service) Send(message string, params *types.Params) error

Send a notification message to discord