plugins

Documentation

Index

• Constants
• Variables
• func RegisterCoroutinePlugin(plugin CoroutinePlugin)
• func RegisterOnMessagePlugin(plugin OnMessagePlugin)
• func RegisterSchedulerPlugin(plugin SchedulerPlugin)
• type AlwaysFireEventPlugin
  • func (p AlwaysFireEventPlugin) IsFireEvent(msg *MessageRequest) bool
• type AlwaysFireNextEventPlugin
  • func (p AlwaysFireNextEventPlugin) IsFireNextEvent(msg *MessageRequest) bool
• type AlwaysNotFireNextEventPlugin
  • func (p AlwaysNotFireNextEventPlugin) IsFireNextEvent(msg *MessageRequest) bool
• type CoroutinePlugin
• type MessageRequest
  • func NewMessageRequsetFromGroupMessage(msg *message.GroupMessage) *MessageRequest
  • func NewMessageRequsetFromPrivateMessage(msg *message.PrivateMessage) *MessageRequest
  • func (m *MessageRequest) GetNickName() string
• type MessageResponse
• type NoInitPlugin
  • func (p NoInitPlugin) PluginInit()
• type NoSortPlugin
  • func (p NoSortPlugin) SortNum() int8
• type OnMessagePlugin
• type PluginInfo
• type SchedulerPlugin

Constants

const (
	//GroupMessage 群消息
	GroupMessage = messageType("group")
	//PrivateMessage 私聊消息
	PrivateMessage = messageType("private")
)

Variables

var Crons = cron.New()

var GlobalCoroutinePlugins []CoroutinePlugin

CoroutinePluginPlugins 全局插件 {'id','plugin'}

var GlobalOnMessagePluginIDs []string

GlobalOnMessagePluginIDs 排序后的全局插件ID

var GlobalOnMessagePlugins = make(map[string]OnMessagePlugin)

GlobalOnMessagePlugins 全局插件 {'name','plugin'}

Functions

func RegisterCoroutinePlugin

func RegisterCoroutinePlugin(plugin CoroutinePlugin)

func RegisterOnMessagePlugin

func RegisterOnMessagePlugin(plugin OnMessagePlugin)

RegisterOnMessagePlugin 注册消息插件

func RegisterSchedulerPlugin

func RegisterSchedulerPlugin(plugin SchedulerPlugin)

RegisterSchedulerPlugin 注册消息插件

Types

type AlwaysFireEventPlugin

type AlwaysFireEventPlugin struct {
}

AlwaysFireEventPlugin 总是触发的插件

func (AlwaysFireEventPlugin) IsFireEvent

func (p AlwaysFireEventPlugin) IsFireEvent(msg *MessageRequest) bool

IsFireEvent 简单插件初始化

type AlwaysFireNextEventPlugin

type AlwaysFireNextEventPlugin struct {
}

AlwaysFireNextEventPlugin 总是触发下一个插件的插件

func (AlwaysFireNextEventPlugin) IsFireNextEvent

func (p AlwaysFireNextEventPlugin) IsFireNextEvent(msg *MessageRequest) bool

IsFireNextEvent IsFireNextEvent

type AlwaysNotFireNextEventPlugin

type AlwaysNotFireNextEventPlugin struct {
}

AlwaysNotFireNextEventPlugin 总是不触发下一个插件的插件

func (AlwaysNotFireNextEventPlugin) IsFireNextEvent

func (p AlwaysNotFireNextEventPlugin) IsFireNextEvent(msg *MessageRequest) bool

IsFireNextEvent IsFireNextEvent

type CoroutinePlugin

type CoroutinePlugin interface {

	//Run 要执行的方法
	Run(c *bot.Bot) error
	// contains filtered or unexported methods
}

CoroutinePlugin 协程插件

type MessageRequest

type MessageRequest struct {
	MessageType    messageType
	ID             int32
	InternalID     int32
	GroupCode      int64
	GroupName      string
	Sender         *message.Sender
	Time           int32
	Elements       []message.IMessageElement
	OriginalObject *msg.Message
	QQClient       *client.QQClient
}

MessageRequest 消息请求

func NewMessageRequsetFromGroupMessage

func NewMessageRequsetFromGroupMessage(msg *message.GroupMessage) *MessageRequest

NewMessageRequsetFromGroupMessage NewMessageRequsetFromGroupMessage

func NewMessageRequsetFromPrivateMessage

func NewMessageRequsetFromPrivateMessage(msg *message.PrivateMessage) *MessageRequest

NewMessageRequsetFromPrivateMessage NewMessageRequsetFromPrivateMessage

func (*MessageRequest) GetNickName

func (m *MessageRequest) GetNickName() string

GetNickName 获取称呼

type MessageResponse

type MessageResponse struct {
	Elements []message.IMessageElement
}

MessageResponse 消息事件返回对象

type NoInitPlugin

type NoInitPlugin struct {
}

NoInitPlugin 无需初始化

func (NoInitPlugin) PluginInit

func (p NoInitPlugin) PluginInit()

PluginInit 简单插件初始化

type NoSortPlugin

type NoSortPlugin struct {
}

NoSortPlugin 无需排序

func (NoSortPlugin) SortNum

func (p NoSortPlugin) SortNum() int8

SortNum 排序

type OnMessagePlugin

type OnMessagePlugin interface {

	//IsFireEvent 是否触发事件
	IsFireEvent(msg *MessageRequest) bool
	//IsFireNextEvent 是否触发后续事件
	IsFireNextEvent(msg *MessageRequest) bool
	//OnMessage 监听消息
	OnMessageEvent(msg *MessageRequest) (*MessageResponse, error)
	// contains filtered or unexported methods
}

OnMessagePlugin 监听消息插件

type PluginInfo

type PluginInfo struct {
	ID          string
	Name        string
	Description string
}

PluginInfo 插件的信息

type SchedulerPlugin

type SchedulerPlugin interface {

	//Cron 表达式
	Cron() string
	//Run 要执行的方法
	Run(c *bot.Bot) error
	// contains filtered or unexported methods
}

SchedulerPlugin 定时器插件