embeds

README

embeds

DiscordGo embeds helper library.

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (eb *Builder) AddField(name, value string, inline ...bool) *Builder
  • func (eb *Builder) Author(name, url, icon string) *Builder
  • func (eb *Builder) Clear() *Builder
  • func (eb *Builder) Color(color int) *Builder
  • func (eb *Builder) Description(desc string) *Builder
  • func (eb *Builder) ErrorTemplate(message string) *Builder
  • func (eb *Builder) FailureTemplate(message string) *Builder
  • func (eb *Builder) Finalize() *discordgo.MessageEmbed
  • func (eb *Builder) Footer(text, icon string) *Builder
  • func (eb *Builder) Image(url string) *Builder
  • func (eb *Builder) InfoTemplate(message string) *Builder
  • func (eb *Builder) SuccessTemplate(message string) *Builder
  • func (eb *Builder) Thumbnail(url string) *Builder
  • func (eb *Builder) Timestamp(ts time.Time) *Builder
  • func (eb *Builder) TimestampString(ts string) *Builder
  • func (eb *Builder) Title(title string) *Builder
  • func (eb *Builder) URL(url string) *Builder
  • func (eb *Builder) WarnTemplate(message string) *Builder

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder is a wrapper around DiscordGo MessageEmbed

func NewBuilder

func NewBuilder() *Builder

NewBuilder returns a new Builder struct with default embed values. Timestamp by default is time.Now() Color by default is 0x439ef1

func (*Builder) AddField

func (eb *Builder) AddField(name, value string, inline ...bool) *Builder

AddField adds a new field to the embed

func (*Builder) Author

func (eb *Builder) Author(name, url, icon string) *Builder

Author sets embed's author

func (*Builder) Clear

func (eb *Builder) Clear() *Builder

Clear empties the embed to reuse one builder for several embeds

func (*Builder) Color

func (eb *Builder) Color(color int) *Builder

Color sets embed's color

func (*Builder) Description

func (eb *Builder) Description(desc string) *Builder

Description sets embed's description'

func (*Builder) ErrorTemplate

func (eb *Builder) ErrorTemplate(message string) *Builder

ErrorTemplate retuns an embed built over an error message template

func (*Builder) FailureTemplate

func (eb *Builder) FailureTemplate(message string) *Builder

FailureTemplate retuns an embed built over an failure message template

func (*Builder) Finalize

func (eb *Builder) Finalize() *discordgo.MessageEmbed

Finalize returns a complete DiscordGo embed

func (*Builder) Footer

func (eb *Builder) Footer(text, icon string) *Builder

Footer sets embed's footer

func (*Builder) Image

func (eb *Builder) Image(url string) *Builder

Image sets embed's image

func (*Builder) InfoTemplate

func (eb *Builder) InfoTemplate(message string) *Builder

func (*Builder) SuccessTemplate

func (eb *Builder) SuccessTemplate(message string) *Builder

SuccessTemplate retuns an embed built over an success message template

func (*Builder) Thumbnail

func (eb *Builder) Thumbnail(url string) *Builder

Thumbnail sets embed's thumbnail

func (*Builder) Timestamp

func (eb *Builder) Timestamp(ts time.Time) *Builder

Timestamp sets embed's timestamp

func (*Builder) TimestampString

func (eb *Builder) TimestampString(ts string) *Builder

func (*Builder) Title

func (eb *Builder) Title(title string) *Builder

Title sets embed's title

func (*Builder) URL

func (eb *Builder) URL(url string) *Builder

func (*Builder) WarnTemplate

func (eb *Builder) WarnTemplate(message string) *Builder

WarnTemplate retuns an embed built over an warn message template