slackbot

package

v0.2.4 Latest Latest Go to latest Published: Feb 25, 2021 License: MIT Imports: 7 Imported by: 0

Details

Package slackbot provides a wrapper around official slack library to simplify building a slack bot. bot uses the slack RTM API. Refer https://api.slack.com/bot-users#creating-bot-user

This section is empty.

View Source

var ErrNotMatch = errors.New("no match")

ErrNotMatch can be returned by MessageHandler to indicate that handler cannot process the message event.

func AddressUser(userID string, userName string) string

AddressUser creates the escape sequence for marking a user in a message.

type Bot struct {

	// configurations
	Handler      Handler
	GroupSupport bool
	// contains filtered or unexported fields
}

Bot represents an RTM connection based Slack Bot instance.

func New(token string, opts ...Option) *Bot

New initializes a Slack Bot instance using RTM API. New does not connect to slack API until Listen() is invoked.

func (bot *Bot) Client() *slack.Client

Client returns the underlying Slack client instance.

func (bot *Bot) Listen(ctx context.Context) error

Listen connects to slack and starts the RTM event connection. Blocks until an unrecoverable error occurs.

func (bot *Bot) Self() slack.UserDetails

Self returns details about the currently connected bot user.

func (bot *Bot) SendMessage(text string, responseTo slack.Msg) error

SendMessage sends the text as message to the given channel on behalf of the bot instance.

type Handler interface {
	Handle(bot *Bot, msg slack.MessageEvent, from slack.User) error
}

Handler implementation can be set to the bot to handle a message event.

type LuaHandler struct {
	InitFile    string
	HandlerFunc string
	// contains filtered or unexported fields
}

LuaHandler implements the Bot handler using a lua scripting layer.

func (h *LuaHandler) Handle(bot *Bot, msg slack.MessageEvent, from slack.User) error

type Option func(bot *Bot)

Option can be provided with New() to customise the bot instance.