plugins

package

v4.1.0+incompatible Latest Latest Go to latest Published: Apr 11, 2021 License: BSD-1-Clause Imports: 2 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

notabug.org/mouz/bot

Links

Open Source Insights

Documentation ¶

Overview ¶

Package plugins defines and maintains supported bot plugins.

Index ¶

func Dispatch(w irc.ResponseWriter, r *irc.Request)
func Load(prof irc.Profile)
func Register(p Plugin)
func Unload(prof irc.Profile)
type Plugin

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func Dispatch ¶

func Dispatch(w irc.ResponseWriter, r *irc.Request)

Dispatch sends the given, incoming IRC message to all plugins.

func Load ¶

func Load(prof irc.Profile)

Load initializes all plugins.

func Register ¶

func Register(p Plugin)

Register registers the given plugin. This is meant to be called during program initialization, by imported plugin packages.

func Unload ¶

func Unload(prof irc.Profile)

Unload unloads all plugins.

Types ¶

type Plugin ¶

type Plugin interface {
	// Load initializes the module and loads any internal resources
	// which may be required.
	Load(irc.Profile) error

	// Unload cleans the module up and unloads any internal resources.
	Unload(irc.Profile) error

	// Dispatch sends the given, incoming IRC message to the plugin for
	// processing as it sees fit.
	Dispatch(irc.ResponseWriter, *irc.Request)
}

Plugin defines the interface for a single plugin.

Source Files ¶

View all Source files

plugins.go

Directories ¶

Path	Synopsis
action Package action binds action commands.	Package action binds action commands.
admin Package admin defines administrative bot commands.	Package admin defines administrative bot commands.
knmi Package knmi provides commands to do current weather lookups.	Package knmi provides commands to do current weather lookups.
owm Package owm provides commands to do current weather lookups.	Package owm provides commands to do current weather lookups.
reminder Package reminder allows a user to schedule a reminder with a custom message.	Package reminder allows a user to schedule a reminder with a custom message.
url Package url defines a plugin, which finds and extracts URLs from incoming chat data.	Package url defines a plugin, which finds and extracts URLs from incoming chat data.
youtube Package youtube provides a minimal set of bindings for Youtube's Data API v3.	Package youtube provides a minimal set of bindings for Youtube's Data API v3.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL