models

Documentation

Index

• type Emoji
  • func (e Emoji) String() string
• type Theme
• type Topic
  • func (t Topic) String() string
• type URLCount

Types

type Emoji

type Emoji struct {
	// User ID of the user that used the emoji/reaction.
	User string
	// Emoji is the emoji that was used **with** delimiters (e.g. ":wave:" not
	// "wave")
	Emoji string
	// Count is the number of times the emoji/reaction has been used by the user.
	Count int
	// Reaction is true if the model represents a count of **reaction** emoji
	// usage and not usage in messages. When Reaction is false the model
	// represents a count of emoji usage in regular messages and not reactions.
	Reaction bool
}

Emoji is a model for storing a count of emoji/reactjion usage for a user ID.

func (Emoji) String

func (e Emoji) String() string

String returns a simple representation of the model mostly useful for debugging.

type Theme

type Theme struct {
	// Name of the theme.
	Name string
	// String representation of the theme (e.g. 8 comma separated hex colours like
	// "#624574,#7C4430,#5F303E,#305F5E,#3F5B32,#62502F,#875566,#3F567A")
	Theme string
	// The user ID of the creator of the theme (note: not the friendly username).
	Creator string
}

Theme is a simple model for storing a Slack theme, its name, and the user ID of its creator.

type Topic

type Topic struct {
	// Creator is the ID of the user that changed the topic (note: not the
	// friendly username).
	Creator string
	// Channel is the ID of the channel that had its topic changed (note: not the
	// friendly channel name).
	Channel string
	// Topic is the topic that was set.
	Topic string
	// Date is the slack timestamp on which the topic date was set.
	Date string
}

Topic is a model for holding topic history information for a channel.

func (Topic) String

func (t Topic) String() string

String is a simple debugging representation for the Topic model.

type URLCount

type URLCount struct {
	// URL is the string representation of the URL.
	URL string
	// Occurrences is a count of how many times the URL has been seen.
	Occurrences int
}

URLCount is a simple model for representing how many times a given URL has been seen.