document channel_api.go

Author: VetSoftKeith

api/channel_api.go

@@ -77,6 +77,7 @@ func NewEmbed() *Embed {
 	}
 }
 
+// SetTitle - Set the Embed title
 func (e *Embed) SetTitle(title string) *Embed {
 	if len(title) > titleLimit {
 		title = title[:titleLimit-4] + " ..."
@@ -86,10 +87,13 @@ func (e *Embed) SetTitle(title string) *Embed {
 	return e
 }
 
+// GetTitle - Get the Embed title
+// Deprecated: Access the struct field directly
 func (e *Embed) GetTitle() string {
 	return e.Title
 }
 
+// SetDescription - Set the Embed description
 func (e *Embed) SetDescription(description string) *Embed {
 	if len(description) > descriptionLimit {
 		description = description[:descriptionLimit-4] + " ..."
@@ -99,10 +103,13 @@ func (e *Embed) SetDescription(description string) *Embed {
 	return e
 }
 
+// GetDescription - Get the Embed description
+// Deprecated: Access the struct field directly
 func (e *Embed) GetDescription() string {
 	return e.Description
 }
 
+// SetURL - Set the Embed URL
 func (e *Embed) SetURL(u string) *Embed {
 	// We only check for an error to validate if it's a properly formed URL
 	if _, err := url.Parse(u); err != nil {
@@ -113,76 +120,98 @@ func (e *Embed) SetURL(u string) *Embed {
 	return e
 }
 
+// GetURL - Get the Embed URL
+// Deprecated: Access the struct field directly
 func (e *Embed) GetURL() string {
 	return e.URL
 }
 
+// SetTimestamp - Set the Embed timestamp
 func (e *Embed) SetTimestamp(ts time.Time) *Embed {
 	e.Timestamp = ts.UTC().Format(time.RFC3339)
 
 	return e
 }
 
+// GetTimestamp - Get the Embed timestamp
+// Deprecated: Access the struct field directly
 func (e *Embed) GetTimestamp() (time.Time, error) {
 	return time.Parse(time.RFC3339, e.Timestamp)
 }
 
+// SetColor - Set the Embed color
 func (e *Embed) SetColor(c int64) *Embed {
 	e.Color = c
 
 	return e
 }
 
+// GetColor - Get the Embed color
+// Deprecated: Access the struct field directly
 func (e *Embed) GetColor() int64 {
 	return e.Color
 }
 
+// SetFooter - Set the Footer
 func (e *Embed) SetFooter(text string, iconURL string) *Embed {
 	e.Footer = newFooter().SetText(text).SetIconURL(iconURL)
 
 	return e
 }
 
+// GetFooter - Get the Embed footer
+// Deprecated: Access the struct field directly
 func (e *Embed) GetFooter() *Footer {
 	return e.Footer
 }
 
+// SetImage - Set the Image
 func (e *Embed) SetImage(imageURL string) *Embed {
 	e.Image = newImage().SetURL(imageURL)
 
 	return e
 }
 
+// GetImage - Get the Embed image
+// Deprecated: Access the struct field directly
 func (e *Embed) GetImage() *Image {
 	return e.Image
 }
 
+// SetThumbnail - Set the Thumbnail
 func (e *Embed) SetThumbnail(thumbnailURL string) *Embed {
 	e.Thumbnail = newThumbnail().SetURL(thumbnailURL)
 
 	return e
 }
 
+// GetThumbnail - Get the Embed thumbnail
+// Deprecated: Access the struct field directly
 func (e *Embed) GetThumbnail() string {
 	return e.Thumbnail.URL
 }
 
+// SetAuthor - Set the Author
 func (e *Embed) SetAuthor(name, url string, iconURL *string) *Embed {
 	e.Author = newAuthor().SetName(name).SetURL(url).SetIconURL(iconURL)
 
 	return e
 }
 
+// GetAuthor - Get the Embed author
+// Deprecated: Access the struct field directly
 func (e *Embed) GetAuthor() *Author {
 	return e.Author
 }
 
+// AddField - Add a singular Field
 func (e *Embed) AddField(name, value string, inline bool) *Embed {
-	e.Fields = append(e.Fields, newField().SetName(name).SetValue(value).SetInline(inline))
+	e.Fields = append(e.Fields, NewField().SetName(name).SetValue(value).SetInline(inline))
 
 	return e
 }
 
+// AddFields - Add multiple fields; must create the Field objects first
 func (e *Embed) AddFields(fields ...*Field) *Embed {
 	if len(fields) == 0 {
 		return e
@@ -193,6 +222,8 @@ func (e *Embed) AddFields(fields ...*Field) *Embed {
 	return e
 }
 
+// GetFields - Get the Embed fields
+// Deprecated: Access the struct field directly
 func (e *Embed) GetFields() []*Field {
 	return e.Fields
 }
@@ -203,6 +234,7 @@ func newFooter() *Footer {
 	return &Footer{}
 }
 
+// SetText - set the Footer text
 func (f *Footer) SetText(text string) *Footer {
 	if len(text) > footerTextLimit {
 		text = text[:footerTextLimit-4] + " ..."
@@ -212,10 +244,13 @@ func (f *Footer) SetText(text string) *Footer {
 	return f
 }
 
+// GetText - Get the Footer text
+// Deprecated: Access the struct field directly
 func (f *Footer) GetText() string {
 	return f.Text
 }
 
+// SetIconURL - set the Footer IconURL
 func (f *Footer) SetIconURL(iconURL string) *Footer {
 	if _, err := url.Parse(iconURL); err != nil {
 		return f
@@ -225,6 +260,8 @@ func (f *Footer) SetIconURL(iconURL string) *Footer {
 	return f
 }
 
+// GetIconURL - Get the Footer icon URL
+// Deprecated: Access the struct field directly
 func (f *Footer) GetIconURL() string {
 	return f.IconURL
 }
@@ -235,6 +272,7 @@ func newImage() *Image {
 	return &Image{}
 }
 
+// SetURL - set the Image URL
 func (i *Image) SetURL(u string) *Image {
 	if _, err := url.Parse(u); err != nil {
 		return i
@@ -244,6 +282,8 @@ func (i *Image) SetURL(u string) *Image {
 	return i
 }
 
+// GetURL - Get the Image URL
+// Deprecated: Access the struct field directly
 func (i *Image) GetURL() string {
 	return i.URL
 }
@@ -254,6 +294,7 @@ func newThumbnail() *Thumbnail {
 	return &Thumbnail{}
 }
 
+// SetURL - set the Thumbnail URL
 func (t *Thumbnail) SetURL(u string) *Thumbnail {
 	if _, err := url.Parse(u); err != nil {
 		return t
@@ -263,6 +304,8 @@ func (t *Thumbnail) SetURL(u string) *Thumbnail {
 	return t
 }
 
+// GetURL - Get the Thumbnail URL
+// Deprecated: Access the struct field directly
 func (t *Thumbnail) GetURL() string {
 	return t.URL
 }
@@ -273,6 +316,7 @@ func newAuthor() *Author {
 	return &Author{}
 }
 
+// SetName - set the Author Name
 func (a *Author) SetName(name string) *Author {
 	if len(name) > authorNameLimit {
 		name = name[:authorNameLimit-4] + " ..."
@@ -282,10 +326,13 @@ func (a *Author) SetName(name string) *Author {
 	return a
 }
 
+// GetName - Get the Author name
+// Deprecated: Access the struct field directly
 func (a *Author) GetName() string {
 	return a.Name
 }
 
+// SetURL - set the Author URL
 func (a *Author) SetURL(u string) *Author {
 	if _, err := url.Parse(u); err != nil {
 		return a
@@ -295,10 +342,13 @@ func (a *Author) SetURL(u string) *Author {
 	return a
 }
 
+// GetURL - Get the Author URL
+// Deprecated: Access the struct field directly
 func (a *Author) GetURL() string {
 	return a.URL
 }
 
+// SetIconURL - set the Author IconURL
 func (a *Author) SetIconURL(u *string) *Author {
 	if _, err := url.Parse(*u); err != nil {
 		return a
@@ -308,12 +358,12 @@ func (a *Author) SetIconURL(u *string) *Author {
 	return a
 }
 
-/* EMBED FIELD */
-
-func newField() *Field {
+// NewField - Create a new base Field to chain against
+func NewField() *Field {
 	return &Field{}
 }
 
+// SetName - set the Field Name
 func (f *Field) SetName(name string) *Field {
 	if len(name) > fieldNameLimit {
 		name = name[:fieldNameLimit-4] + " ..."
@@ -323,10 +373,13 @@ func (f *Field) SetName(name string) *Field {
 	return f
 }
 
+// GetName - Get the Field name
+// Deprecated: Access the struct field directly
 func (f *Field) GetName() string {
 	return f.Name
 }
 
+// SetValue - set the Field Value
 func (f *Field) SetValue(value string) *Field {
 	if len(value) > fieldValueLimit {
 		value = value[:fieldValueLimit-4] + " ..."
@@ -336,16 +389,20 @@ func (f *Field) SetValue(value string) *Field {
 	return f
 }
 
+// GetValue - Get the Field value
+// Deprecated: Access the struct field directly
 func (f *Field) GetValue() string {
 	return f.Value
 }
 
+// SetInline - set the Field Inline
 func (f *Field) SetInline(inline bool) *Field {
 	f.Inline = inline
 
 	return f
 }
 
+// IsInline - Helper function for testing is inline
 func (f *Field) IsInline() bool {
 	return f.Inline
 }