embedutil

Documentation

Overview

Package embedutil deals with embeds.

Index

• Constants
• type Embed
  • func NewEmbed(title string, description string) Embed
  • func (embed *Embed) AddField(name, value string, inline bool) *Embed
  • func (embed *Embed) SetAuthor(args ...string) *Embed
  • func (embed *Embed) SetFooter(args ...string) *Embed
  • func (embed *Embed) SetImage(args ...string) *Embed
  • func (embed *Embed) SetThumbnail(args ...string) *Embed

Constants

const (
	LimitTitle       = 256
	LimitDescription = 2048
	LimitFieldName   = 256
	LimitFieldValue  = 1024
	LimitField       = 25
	LimitFooter      = 2048
)

Embed limits.

Types

type Embed

type Embed struct {
	*discordgo.MessageEmbed
}

Embed represents a discord embed.

func NewEmbed

func NewEmbed(title string, description string) Embed

NewEmbed makes a new Embed object.

func (*Embed) AddField

func (embed *Embed) AddField(name, value string, inline bool) *Embed

AddField adds a field to the embedutil.

func (*Embed) SetAuthor

func (embed *Embed) SetAuthor(args ...string) *Embed

SetAuthor sets author name, URL and icon URL of an embedutil.

func (*Embed) SetFooter

func (embed *Embed) SetFooter(args ...string) *Embed

SetFooter sets the footer text and image of an embedutil.

func (*Embed) SetImage

func (embed *Embed) SetImage(args ...string) *Embed

SetImage sets the image URL of an embedutil.

func (*Embed) SetThumbnail

func (embed *Embed) SetThumbnail(args ...string) *Embed

SetThumbnail sets the thumbnail URL of an embedutil.