reminders

Documentation

Index

• func AddReminder(r Reminder) error
• func Init()
• func Start()
• type Config
• type Reminder
  • func (r Reminder) Run()

Functions

func AddReminder

func AddReminder(r Reminder) error

AddReminder adds a reminder to the scheduler.

func Init

func Init()

Init initializes the reminder scheduler.

func Start

func Start()

Start starts the reminder scheduler.

Types

type Config

type Config struct {
	Team            int            `db:"team"`
	Activities      pq.StringArray `db:"activities"`
	AnnounceChannel string         `db:"announce_channel"`
	RoleMention     sql.NullString `db:"role_mention"`
	Intervals       pq.Int64Array  `db:"intervals"`
}

Config holds a team's reminder configuration.

type Reminder

type Reminder struct {
	State  *state.State
	Team   *team.Team
	Config *Config
	// contains filtered or unexported fields
}

Reminder will check if there's an activity coming up that needs pinging

func (Reminder) Run

func (r Reminder) Run()

Run checks if there's an activity coming up, and sends an announcement if it's the first one of the day