bot

package

v0.4.1 Latest Latest Go to latest Published: Apr 29, 2020 License: GPL-3.0 Imports: 15 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

This section is empty.

This section is empty.

func Background(hs ...hugot.BackgroundHandler) error

Background adds the provided handler to the Mux of the DefaultBot.

func Command(c *command.Handler)

Command adds a CLI command to the DefaultBot

func HandleHTTP(h hugot.WebHookHandler)

HandleHTTP adds the provided handler to the Mux of the DefaultBot.

func Hears(hs ...hears.Hearer) error

Hears adds the provided handle to the Mux of the DefaultBotr.

func ListenAndServe(ctx context.Context, h hugot.Handler, a hugot.Adapter, as ...hugot.Adapter)

ListenAndServe runs the DefaultBot handler loop.

func Raw(hs ...hugot.Handler) error

Raw adds the provided handler to the Mux of the DefaultBot.

func SetURL(b *url.URL)

SetURL sets the base URL for web hooks on the DefaultBot.

func URL() *url.URL

URL returns the base URL for the Mux of the DefaultBot

type Bot struct {
	Store    storage.Storer
	Mux      *mux.Mux
	Commands command.Set
}

Bot is the main type for implementing chat bots. They listen on one or more adapters and pass messages to, and from handlers.

var DefaultBot *Bot

DefaultBot is a default instance of a bot

func New() *Bot

New creates a new bot.

func (b *Bot) Command(c *command.Handler)

Command adds a CLI command to the Bot

func (b *Bot) ListenAndServe(ctx context.Context, h hugot.Handler, a hugot.Adapter, as ...hugot.Adapter)

ListenAndServe runs the handler h, passing all messages to/from the provided adapter. The context may be used to gracefully shut down the server.