structs.go

package robot

import "log"

// AttrRet implements Stringer so it can be interpolated with fmt if
// the plugin author is ok with ignoring the RetVal.
type AttrRet struct {
	Attribute string
	RetVal
}

func (a AttrRet) String() string {
	return a.Attribute
}

// Message is passed to each task as it runs, initialized from the botContext.
// Tasks can copy and modify the Robot without affecting the botContext.
type Message struct {
	User            string            // The user who sent the message; this can be modified for replying to an arbitrary user
	ProtocolUser    string            // the protocol internal ID of the user
	Channel         string            // The channel where the message was received, or "" for a direct message. This can be modified to send a message to an arbitrary channel.
	ProtocolChannel string            // the protocol internal channel ID
	Protocol        Protocol          // slack, terminal, test, others; used for interpreting rawmsg or sending messages with Format = 'Raw'
	Incoming        *ConnectorMessage // raw struct of message sent by connector; interpret based on protocol. For Slack this is a *slack.MessageEvent
	Format          MessageFormat     // The outgoing message format, one of Raw, Fixed, or Variable
}

// ConnectorMessage is passed in to the robot for every incoming message seen.
// The *ID fields are required invariant internal representations that the
// protocol accepts in it's interface methods.
type ConnectorMessage struct {
	// Protocol - string name of connector, e.g. "Slack"
	Protocol string
	// optional UserName and required internal UserID
	UserName, UserID string
	// optional / required channel values
	ChannelName, ChannelID string
	// DirectMessage - whether the message should be considered private between user and robot
	DirectMessage bool
	// BotMessage - true when the connector is certain the message has been sent to the robot,
	// e.g. for slack slash commands
	BotMessage bool
	// MessageText - sanitized message text, with all protocol-added junk removed
	MessageText string
	// MessageObject, Client - interfaces for the raw objects; go extensions can use
	// these with type switches/assertions to access object internals
	MessageObject, Client interface{}
}

// PluginHandler is the struct a Go plugin registers for the Gopherbot plugin API.
type PluginHandler struct {
	DefaultConfig string /* A yaml-formatted multiline string defining the default Plugin configuration. It should be liberally commented for use in generating
	custom configuration for the plugin. If a Config: section is defined, it should match the structure of the optional Config interface{} */
	Handler func(r Robot, command string, args ...string) TaskRetVal // The callback function called by the robot whenever a Command is matched
	Config  interface{}                                              // An optional empty struct defining custom configuration for the plugin
}

// JobHandler is the struct registered for a Go job
type JobHandler struct {
	Handler func(r Robot, args ...string) TaskRetVal // The callback function called by the robot when the job is run
	Config  interface{}                              // An optional empty struct defining custom configuration for the job
}

// TaskHandler is the struct registered for a Go task
type TaskHandler struct {
	Handler func(r Robot, args ...string) TaskRetVal // The callback for this Go task
}

// PluginSpec used by loadable plugins that return a slice of PluginSpecs
type PluginSpec struct {
	Name    string
	Handler PluginHandler
}

// JobSpec used by loadable plugins that return a slice of JobSpecs
type JobSpec struct {
	Name    string
	Handler JobHandler
}

// TaskSpec used by loadable plugins that return a slice of TaskSpecs
type TaskSpec struct {
	Name              string
	RequiresPrivilege bool
	Handler           TaskHandler
}

// ConnectorSpec for specifying a connector
type ConnectorSpec struct {
	Name      string
	Connector func(Handler, *log.Logger) Connector
}

// BrainSpec for specifying a connector
type BrainSpec struct {
	Name  string
	Brain func(Handler) SimpleBrain
}

// HistorySpec for specifying a connector
type HistorySpec struct {
	Name     string
	Provider func(Handler) HistoryProvider
}

// Manifest lists all the handlers available from a given loadable module
type Manifest struct {
	Tasks     []TaskSpec
	Plugins   []PluginSpec
	Jobs      []JobSpec
	Connector ConnectorSpec
	Brain     BrainSpec
	History   HistorySpec
}