reminderplugin

Documentation

Index

• func New() bruxism.Plugin
• type Reminder
• type ReminderPlugin
  • func (p *ReminderPlugin) AddReminder(reminder *Reminder) error
  • func (p *ReminderPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, ...) []string
  • func (p *ReminderPlugin) Load(bot *bruxism.Bot, service bruxism.Service, data []byte) error
  • func (p *ReminderPlugin) Message(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message)
  • func (p *ReminderPlugin) Name() string
  • func (p *ReminderPlugin) Run(bot *bruxism.Bot, service bruxism.Service)
  • func (p *ReminderPlugin) Save() ([]byte, error)
  • func (p *ReminderPlugin) SendReminder(service bruxism.Service, reminder *Reminder)
  • func (p *ReminderPlugin) Stats(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message) []string

Functions

func New

func New() bruxism.Plugin

New will create a new Reminder plugin.

Types

type Reminder

type Reminder struct {
	StartTime time.Time
	Time      time.Time
	Requester string
	Target    string
	Message   string
	IsPrivate bool
}

A Reminder holds data about a specific reminder.

type ReminderPlugin

type ReminderPlugin struct {
	sync.RWMutex

	Reminders      []*Reminder
	TotalReminders int
	// contains filtered or unexported fields
}

ReminderPlugin is a plugin that reminds users.

func (*ReminderPlugin) AddReminder

func (p *ReminderPlugin) AddReminder(reminder *Reminder) error

AddReminder adds a reminder.

func (*ReminderPlugin) Help

func (p *ReminderPlugin) Help(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message, detailed bool) []string

Help returns a list of help strings that are printed when the user requests them.

func (*ReminderPlugin) Load

func (p *ReminderPlugin) Load(bot *bruxism.Bot, service bruxism.Service, data []byte) error

Load will load plugin state from a byte array.

func (*ReminderPlugin) Message

func (p *ReminderPlugin) Message(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message)

func (*ReminderPlugin) Name

func (p *ReminderPlugin) Name() string

Name returns the name of the plugin.

func (*ReminderPlugin) Run

func (p *ReminderPlugin) Run(bot *bruxism.Bot, service bruxism.Service)

Run will block until a reminder needs to be fired and then fire it.

func (*ReminderPlugin) Save

func (p *ReminderPlugin) Save() ([]byte, error)

Save will save plugin state to a byte array.

func (*ReminderPlugin) SendReminder

func (p *ReminderPlugin) SendReminder(service bruxism.Service, reminder *Reminder)

SendReminder sends a reminder.

func (*ReminderPlugin) Stats

func (p *ReminderPlugin) Stats(bot *bruxism.Bot, service bruxism.Service, message bruxism.Message) []string

Stats will return the stats for a plugin.