botmaid

type API ¶

type API interface {
	GetUpdates(GetUpdatesConfig) (UpdateChannel, ErrorChannel)
	Push(Update) (Update, error)
}

API is an interface including some common behaviors for APIs.

GetUpdates always gets updates and errors into the channels with a given config.

Push always pushes an update and returns it back if existing.

Delete always deletes a specific update.

type APICqhttp ¶

type APICqhttp struct {
	AccessToken string
	Secret      string
	APIEndpoint string
}

APICqhttp is a struct stores some basic information of the CQHTTP. Please search in CQHTTP document for details.

func (a *APICqhttp) API(end string, m map[string]interface{}) (interface{}, error)

func (a *APICqhttp) GetUpdates(pc GetUpdatesConfig) (UpdateChannel, ErrorChannel)

func (a *APICqhttp) Push(update Update) (Update, error)

type APITelegramBot ¶

type APITelegramBot struct {
	Token  string
	Offset int64
}

APITelegramBot is a struct stores some basic information of the Telegram Bot API. Please search in official API document for details.

func (a *APITelegramBot) API(end string, m map[string]interface{}) (interface{}, error)

func (a *APITelegramBot) GetUpdates(pc GetUpdatesConfig) (UpdateChannel, ErrorChannel)

func (a *APITelegramBot) Push(update Update) (Update, error)

type Bot ¶

type Bot struct {
	ID      string
	API     API
	Self    *User
	BotMaid *BotMaid
}

Bot includes some information of a bot.

func (b *Bot) At(u *User) []string

func (b *Bot) BeAt(u *Update) bool

func (b *Bot) IsCommand(u *Update, c []string) bool

func (b *Bot) IsMaster(u *User) bool

func (b *Bot) Platform() string

func (b *Bot) Reply(u *Update, s ...string) (Update, error)

type BotMaid ¶

type BotMaid struct {
	Bots      map[string]*Bot
	Conf      *botMaidConfig
	Redis     *redis.Client
	Commands  []Command
	Timers    []Timer
	HelpMenus []HelpMenu
	Words     map[string][]string
	RespTime  time.Time
}

BotMaid includes a slice of Bot and some methods to use them.

func New(configFile string) (*BotMaid, error)

func (bm *BotMaid) AddCommand(c Command)

func (bm *BotMaid) AddTimer(t Timer)

func (bm *BotMaid) Broadcast(key string, m *Message)

func (bm *BotMaid) Start() error

func (bm *BotMaid) SwitchBroadcast(key string, c *Chat, b *Bot)

type Chat ¶

type Chat struct {
	ID    int64
	Type  string
	Title string
}

Chat is a struct for a chat.

type Command ¶

type Command struct {
	Do                     func(*Update, *Bot) bool
	Priority               int
	Menu, MenuText, Help   string
	Names                  []string
	ArgsMinLen, ArgsMaxLen int
	Master                 bool
}

Command is a func with priority value so that we can sort some Commands to make them in a specific order.

type CommandSlice ¶

type CommandSlice []Command

CommandSlice is a slice of Command that could be sort.

func (cs CommandSlice) Len() int

func (cs CommandSlice) Less(i, j int) bool

func (cs CommandSlice) Swap(i, j int)

type ErrorChannel ¶

type ErrorChannel chan error

ErrorChannel is a channel for saving errors.

type GetUpdatesConfig ¶ added in v1.4.0

type GetUpdatesConfig struct {
	Limit            int
	Timeout          int
	RetryWaitingTime time.Duration
}

GetUpdatesConfig is a struct for getting updates.

Limit decides the number of updates pulled once. Timeout decides the timeout of long polling. RetryWaitingTime decides decides the time waiting after pulling an error.

type HelpMenu ¶ added in v1.7.0

type HelpMenu struct {
	Menu, Help string
	Names      []string
}

HelpMenu describes the menu item of the help.

type Message ¶

type Message struct {
	ID      int64
	Text    string
	Image   string
	Audio   string
	Args    []string
	Command string
}

Message is a struct for a message of an update.

type Timer ¶

type Timer struct {
	Do         func()
	Start, End time.Time
	Frequency  time.Duration
}

Timer is a func with time and frequency so that we can call it at some specific time.

type Update ¶

type Update struct {
	ID      int64
	Type    string
	Time    time.Time
	Chat    *Chat
	User    *User
	Message *Message
}

Update is a struct for an update of APIs.

type UpdateChannel ¶

type UpdateChannel chan Update

UpdateChannel is a channel for saving updates.

type User ¶

type User struct {
	ID       int64
	UserName string
	NickName string
}

User is a struct for a user.

type Word ¶ added in v1.0.1

type Word struct {
	Word   string
	Weight int
}

Word is a string with weight so that we can choose them randomly.

type WordSlice ¶ added in v1.3.0

type WordSlice []Word

WordSlice is a slice of Word.

func (ws WordSlice) Random() string