models

Documentation

Overview

Package models defines database data models.

Index

• Variables
• type BotBan
• type CacheBoolItem
• type CacheStringItem
• type ChannelCommandCooldown
• type Duel
• type GambaTransaction
• type JoinedChannel
• type Message
• type User
• type UserCommandCooldown

Variables

var AllModels = []any{
	BotBan{},
	CacheBoolItem{},
	CacheStringItem{},
	ChannelCommandCooldown{},
	Duel{},
	GambaTransaction{},
	JoinedChannel{},
	Message{},
	User{},
	UserCommandCooldown{},
}

AllModels contains one of each defined data model, for auto-migrations.

Types

type BotBan

type BotBan struct {
	gorm.Model

	// Platform contains the which platform this channel is on.
	Platform string
	// Channel is which channel should be joined.
	Channel string
	// JoinedAt is when the channel was joined.
	BannedAt time.Time
}

BotBan represents a bot being banned from a channel.

type CacheBoolItem

type CacheBoolItem struct {
	CreatedAt time.Time
	UpdatedAt time.Time

	// Key is the item's key.
	Key string `gorm:"primarykey"`
	// Value is the item's value.
	Value bool
	// ExpiresAt is when the item expires.
	// If 0, the item never expires.
	ExpiresAt time.Time
}

CacheBoolItem is a cache item of type bool.

type CacheStringItem

type CacheStringItem struct {
	CreatedAt time.Time
	UpdatedAt time.Time

	// Key is the item's key.
	Key string `gorm:"primarykey"`
	// Value is the item's value.
	Value string
	// ExpiresAt is when the item expires.
	// If 0, the item never expires.
	ExpiresAt time.Time
}

CacheBoolItem is a cache item of type string.

type ChannelCommandCooldown

type ChannelCommandCooldown struct {
	gorm.Model

	// Channel is the channel the command has a cooldown in.
	Channel string
	// Command is the name of the command with a cooldown.
	Command string
	// LastRun is when the command was last run in the channel.
	LastRun time.Time
}

ChannelCommandCooldown contains a record of a command cooldown in a channel.

type Duel

type Duel struct {
	gorm.Model

	// UserID is the ID of the user that initiated the duel.
	UserID uint
	// User is the user that initiated the duel.
	User User
	// TargetID is the ID of the target of the duel.
	TargetID uint
	// Target is the target of the duel.
	Target User
	// Amount is the amount duelled.
	Amount int64
	// Pending is whether the duel is pending.
	Pending bool
	// Accepted is whether the target user has accepted the duel.
	Accepted bool
	// Won is whether the user won the duel.
	Won bool
}

Duel represents a gamba duel.

type GambaTransaction

type GambaTransaction struct {
	gorm.Model

	// UserID is the ID of the user that executed the transaction.
	UserID uint
	// User is the user that executed the transaction.
	User User
	// Game is the gamba game the transaction was for.
	Game string
	// Delta is the win/loss of the transaction.
	Delta int64
}

GambaTransaction represents a single gamba transaction.

type JoinedChannel

type JoinedChannel struct {
	gorm.Model

	// Platform contains the which platform this channel is on.
	Platform string
	// Channel is which channel should be joined.
	Channel string
	// ChannelID is the ID of the channel to be joined.
	ChannelID string
	// Prefix is the prefix to be used in the channel.
	Prefix string
	// JoinedAt is when the channel was joined.
	JoinedAt time.Time
}

JoinedChannel represents a channel the bot should join.

type Message

type Message struct {
	gorm.Model

	// Text contains the text of the message.
	Text string
	// Channel represents the channel the message was sent in
	// (or should be sent in).
	Channel string
	// UserID is the ID of the user that sent the message.
	UserID uint
	// User is the username of the user that sent the message.
	User User
	// Time is when the message was sent.
	Time time.Time
}

Message represents a chat message.

type User

type User struct {
	gorm.Model

	// TwitchID is the user's ID on Twitch, if known
	TwitchID string
	// TwitchName is the user's username on Twitch, if known
	TwitchName string
}

User represents a user.

type UserCommandCooldown

type UserCommandCooldown struct {
	gorm.Model

	// UserID is the ID of the user with the cooldown.
	UserID uint
	// User is the user with the cooldown.
	User User
	// Command is the name of the command with a cooldown.
	Command string
	// LastRun is when the command was last run in the channel.
	LastRun time.Time
}

UserCommandCooldown contains a record of a command cooldown for a user.