bot

package

Go to main page

Versions in this module

v2

v2.6.3

Dec 30, 2022

v2.6.2

Dec 20, 2022

v2.6.1

Dec 16, 2022

v2.6.0

Dec 14, 2022

Changes in this version

type Robot

+ func (r Robot) PromptThreadForReply(regexID string, prompt string, v ...interface{}) (string, robot.RetVal)

+ func (r Robot) PromptUserChannelThreadForReply(regexID string, user, channel, thread string, prompt string, v ...interface{}) (string, robot.RetVal)

+ func (r Robot) ReplyThread(msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SayThread(msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SendChannelThreadMessage(ch, thr, msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SendUserChannelThreadMessage(u, ch, thr, msg string, v ...interface{}) robot.RetVal

v2.5.2

Aug 1, 2022

v2.5.1

Jul 5, 2022

v2.5.0

Jul 1, 2022

v2.4.9

May 31, 2022

v2.4.8

May 28, 2022

v2.4.7

Apr 19, 2022

v2.4.6

Jan 24, 2022

v2.4.5

Jan 19, 2022

v2.4.4

Jan 7, 2022

v2.4.3

Jan 1, 2022

v2.4.2

Oct 22, 2021

v2.4.1

Oct 18, 2021

v2.4.0

Oct 8, 2021

v2.3.0

Oct 8, 2021

Changes in this version

type ConfigLoader

+ ParameterSets map[string]TaskSettings

+ type ParameterSet struct

+ Description string

+ Parameters []robot.Parameter

type Task

+ ParameterSets []string

type TaskSettings

+ ParameterSets []string

v2.2.0

Sep 11, 2021

Changes in this version

+ func GetEvents() *[]Event

+ func Initialize(handler robot.Handler, l *log.Logger) robot.Connector

+ func Log(l robot.LogLevel, m string, v ...interface{}) bool

+ func ReadBinary(in io.Reader) (*[]byte, error)

+ func ReadBinaryFile(filename string) (*[]byte, error)

+ func RegisterConnector(name string, connstarter func(robot.Handler, *log.Logger) robot.Connector)

+ func RegisterHistoryProvider(name string, provider func(robot.Handler) robot.HistoryProvider)

+ func RegisterJob(name string, gojob robot.JobHandler)

+ func RegisterPlugin(name string, plug robot.PluginHandler)

+ func RegisterPreload(s string)

+ func RegisterSimpleBrain(name string, provider func(robot.Handler) robot.SimpleBrain)

+ func RegisterTask(name string, privRequired bool, gotask robot.TaskHandler)

+ func Start(v VersionInfo)

+ func StartTest(v VersionInfo, cfgdir, logfile string, t *testing.T) (chan bool, robot.Connector)

+ func Wrap(s string, limit int) string

+ func WriteBase64(out io.Writer, b *[]byte) error

+ func WriteBase64File(filename string, b *[]byte) error

+ type ChannelInfo struct

+ ChannelID string

+ ChannelName string

+ type ConfigLoader struct

+ AdminContact string

+ AdminUsers []string

+ Alias string

+ BotInfo *UserInfo

+ Brain string

+ BrainConfig json.RawMessage

+ ChannelRoster []ChannelInfo

+ DefaultAllowDirect bool

+ DefaultAuthorizer string

+ DefaultChannels []string

+ DefaultElevator string

+ DefaultJobChannel string

+ DefaultMessageFormat string

+ EncryptBrain bool

+ EncryptionKey string

+ ExternalJobs map[string]TaskSettings

+ ExternalPlugins map[string]TaskSettings

+ ExternalTasks map[string]TaskSettings

+ GoJobs map[string]TaskSettings

+ GoPlugins map[string]TaskSettings

+ GoTasks map[string]TaskSettings

+ HistoryConfig json.RawMessage

+ HistoryProvider string

+ IgnoreUnlistedUsers bool

+ IgnoreUsers []string

+ JoinChannels []string

+ LoadableModules map[string]LoadableModule

+ LocalPort int

+ LogLevel string

+ MailConfig botMailer

+ NameSpaces map[string]TaskSettings

+ Protocol string

+ ProtocolConfig json.RawMessage

+ ScheduledJobs []ScheduledTask

+ TimeZone string

+ UserRoster []UserInfo

+ WorkSpace string

+ type Event int

+ const AdminCheckFailed

+ const AdminCheckPassed

+ const AmbientTaskRan

+ const AuthNoRunMisconfigured

+ const AuthNoRunNotFound

+ const AuthNoRunPlugNotAvailable

+ const AuthRanFail

+ const AuthRanFailNormal

+ const AuthRanFailOther

+ const AuthRanMechanismFailed

+ const AuthRanSuccess

+ const BotDirectMessage

+ const CatchAllTaskRan

+ const CatchAllsRan

+ const CommandTaskRan

+ const ElevNoRunMisconfigured

+ const ElevNoRunNotAvailable

+ const ElevNoRunNotFound

+ const ElevRanFail

+ const ElevRanFailNormal

+ const ElevRanFailOther

+ const ElevRanMechanismFailed

+ const ElevRanSuccess

+ const ExternalTaskBadInterpreter

+ const ExternalTaskBadPath

+ const ExternalTaskErrExit

+ const ExternalTaskRan

+ const ExternalTaskStderrOutput

+ const GoPluginRan

+ const IgnoredUser

+ const JobTaskRan

+ const MultipleMatchesNoAction

+ const ScheduledTaskRan

+ const SpawnedTaskRan

+ const TriggeredTaskRan

+ func (i Event) String() string

+ type InputMatcher struct

+ Command string

+ Contexts []string

+ Label string

+ Regex string

+ type Job struct

+ Arguments []InputMatcher

+ KeepLogs int

+ Quiet bool

+ Triggers []JobTrigger

+ type JobTrigger struct

+ Channel string

+ Regex string

+ User string

+ type LoadableModule struct

+ Description string

+ Disabled bool

+ Name string

+ Path string

+ type NameSpace struct

+ Description string

+ Parameters []robot.Parameter

+ type Plugin struct

+ AdminCommands []string

+ AuthorizeAllCommands bool

+ AuthorizedCommands []string

+ CatchAll bool

+ CommandMatchers []InputMatcher

+ ElevateImmediateCommands []string

+ ElevatedCommands []string

+ Help []PluginHelp

+ MatchUnlisted bool

+ MessageMatchers []InputMatcher

+ type PluginHelp struct

+ Helptext []string

+ Keywords []string

+ type Robot struct

+ func (r Robot) AddCommand(plugname, command string) robot.RetVal

+ func (r Robot) AddJob(name string, args ...string) robot.RetVal

+ func (r Robot) AddTask(name string, args ...string) robot.RetVal

+ func (r Robot) CheckAdmin() bool

+ func (r Robot) CheckinDatum(key, locktoken string)

+ func (r Robot) CheckoutDatum(key string, datum interface{}, rw bool) (locktoken string, exists bool, ret robot.RetVal)

+ func (r Robot) Direct() robot.Robot

+ func (r Robot) Elevate(immediate bool) bool

+ func (r Robot) Email(subject string, messageBody *bytes.Buffer, html ...bool) (ret robot.RetVal)

+ func (r Robot) EmailAddress(address, subject string, messageBody *bytes.Buffer, html ...bool) (ret robot.RetVal)

+ func (r Robot) EmailUser(user, subject string, messageBody *bytes.Buffer, html ...bool) (ret robot.RetVal)

+ func (r Robot) Exclusive(tag string, queueTask bool) (success bool)

+ func (r Robot) ExtendNamespace(ext string, histories int) bool

+ func (r Robot) FailCommand(plugname, command string) robot.RetVal

+ func (r Robot) FailTask(name string, args ...string) robot.RetVal

+ func (r Robot) FinalCommand(plugname, command string) robot.RetVal

+ func (r Robot) FinalTask(name string, args ...string) robot.RetVal

+ func (r Robot) Fixed() robot.Robot

+ func (r Robot) GetBotAttribute(a string) *robot.AttrRet

+ func (r Robot) GetMessage() *robot.Message

+ func (r Robot) GetParameter(key string) string

+ func (r Robot) GetRepoData() map[string]robot.Repository

+ func (r Robot) GetSenderAttribute(a string) *robot.AttrRet

+ func (r Robot) GetTaskConfig(dptr interface{}) robot.RetVal

+ func (r Robot) GetUserAttribute(u, a string) *robot.AttrRet

+ func (r Robot) Log(l robot.LogLevel, msg string, v ...interface{}) (logged bool)

+ func (r Robot) MessageFormat(f robot.MessageFormat) robot.Robot

+ func (r Robot) Pause(s float64)

+ func (r Robot) PromptForReply(regexID string, prompt string, v ...interface{}) (string, robot.RetVal)

+ func (r Robot) PromptUserChannelForReply(regexID string, user string, channel string, prompt string, v ...interface{}) (string, robot.RetVal)

+ func (r Robot) PromptUserForReply(regexID string, user string, prompt string, v ...interface{}) (string, robot.RetVal)

+ func (r Robot) RaisePriv(reason string)

+ func (r Robot) RandomInt(n int) int

+ func (r Robot) RandomString(s []string) string

+ func (r Robot) Recall(key string) string

+ func (r Robot) Remember(key, value string)

+ func (r Robot) RememberContext(context, value string)

+ func (r Robot) Reply(msg string, v ...interface{}) robot.RetVal

+ func (r Robot) Say(msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SendChannelMessage(ch, msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SendUserChannelMessage(u, ch, msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SendUserMessage(u, msg string, v ...interface{}) robot.RetVal

+ func (r Robot) SetParameter(name, value string) bool

+ func (r Robot) SetWorkingDirectory(path string) bool

+ func (r Robot) SpawnJob(name string, args ...string) robot.RetVal

+ func (r Robot) UpdateDatum(key, locktoken string, datum interface{}) (ret robot.RetVal)

+ type ScheduledTask struct

+ Schedule string

+ type Task struct

+ AllChannels bool

+ AllowDirect bool

+ AuthRequire string

+ Authorizer string

+ Channel string

+ Channels []string

+ Config json.RawMessage

+ Description string

+ DirectOnly bool

+ Disabled bool

+ Elevator string

+ Homed bool

+ NameSpace string

+ Parameters []robot.Parameter

+ Path string

+ Privileged bool

+ ReplyMatchers []InputMatcher

+ RequireAdmin bool

+ Users []string

+ type TaskSettings struct

+ Description string

+ Disabled bool

+ Homed bool

+ Name string

+ NameSpace string

+ Parameters []robot.Parameter

+ Path string

+ Privileged *bool

+ type TaskSpec struct

+ Arguments []string

+ Command string

+ Name string

+ type UserInfo struct

+ BotUser bool

+ Email string

+ FirstName string

+ FullName string

+ LastName string

+ Phone string

+ UserID string

+ UserName string

+ type VersionInfo struct

+ Commit string

+ Version string

+ type Wrapper struct

+ Breakpoints string

+ LimitIncludesPrefixSuffix bool

+ Newline string

+ OutputLinePrefix string

+ OutputLineSuffix string

+ StripTrailingNewline bool

+ TrimInputPrefix string

+ TrimInputSuffix string

+ func NewWrapper() Wrapper

+ func (w Wrapper) Wrap(s string, limit int) string

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