followers

Documentation

Overview

Package followers implements a plugin which invites specified people to join channels the bot joins. It assumes that servers reply to a succesful join with RPL_CHANNELMODEIS (324). It's not in RFC but it's pretty popular behaviour. Note: it WILL invite the followers if RPL_CHANNELMODEIS is sent because of other event.

Index

• type Guru
  • func Register(b bot.Bot) *Guru
  • func (g *Guru) Add(follower string)
  • func (g *Guru) Close()
  • func (g *Guru) Del(follower string)

Types

type Guru

type Guru struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

Guru is a structure which holds list of bot's followers. Use Register to create one.

func Register

func Register(b bot.Bot) *Guru

Register creates a Guru (plugin's instance) and registers it with the bot. Use Close to stop the instance.

func (*Guru) Add

func (g *Guru) Add(follower string)

Add causes the bot to send invites to the follower.

func (*Guru) Close

func (g *Guru) Close()

Close stops the Guru from inviting the followers.

func (*Guru) Del

func (g *Guru) Del(follower string)

Del stops the bot from sending invites to the follower.