jsonapi

Documentation

Index

• type Embed
• type EmbedField
• type EmbedFooter
• type GatewayResponse
• type Message
• type MessageWithEmbed

Types

type Embed

type Embed struct {
	Title       string       `json:"title,omitempty"`
	Description string       `json:"description,omitempty"`
	URL         string       `json:"url"`
	Timestamp   string       `json:"timestamp,omitempty"`
	Color       int          `json:"color,omitempty"`
	Fields      []EmbedField `json:"fields"`
	Footer      EmbedFooter  `json:"footer,omitempty"`
}

Embed is a json object that represents an embed in a MessageWithEmbed

type EmbedField

type EmbedField struct {
	Name   string `json:"name"`
	Value  string `json:"value"`
	Inline bool   `json:"inline"`
}

EmbedField is a json object that represents a field in an Embed

type EmbedFooter

type EmbedFooter struct {
	Text string `json:"text"`
}

EmbedFooter is a json object that represents the footer of an embed

type GatewayResponse

type GatewayResponse struct {
	URL    string `json:"url"`
	Shards int    `json:"shards"`
}

GatewayResponse is the json object received from the discord api when requesting gateway connection information

type Message

type Message struct {
	Content string `json:"content"`
	Tts     bool   `json:"tts"`
}

Message is the json object that is sent to the discord api to post a plain-text message to a server

type MessageWithEmbed

type MessageWithEmbed struct {
	Content string `json:"content"`
	Tts     bool   `json:"tts"`
	Embed   Embed  `json:"embed"`
}

MessageWithEmbed is the json object that is sent to the discord api to post an embed message to a server