Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security Policy
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

sarah

package module

Go to main page

Versions in this module

v1

v1.6.0

Apr 28, 2019

v1.5.1

Mar 30, 2019

v1.5.0

Jun 18, 2018

Changes in this version

+ type BotStatus struct

+ Running bool

+ Type BotType

type Runner

+ Status func() Status

+ type Status struct

+ Bots []BotStatus

+ Running bool

v1.4.0

Jun 10, 2018

v1.3.2

May 17, 2018

v1.3.1

May 2, 2018

v1.3.0

May 1, 2018

v1.2.1

Feb 11, 2018

v1.2.0

Aug 19, 2017

v1.1.0

Jul 23, 2017

v1.0.1

Jul 9, 2017

v1.0.0

Jul 4, 2017

Changes in this version

+ var ErrCommandInsufficientArgument = errors.New(...)

+ var ErrTaskInsufficientArgument = errors.New("BotType, Identifier and Func must be set.")

+ var ErrTaskScheduleNotGiven = errors.New("Task schedule is not set or given from config struct.")

+ func NewBlockedInputError(i int) error

+ func NewBotNonContinuableError(errorContent string) error

+ func StripMessage(pattern *regexp.Regexp, input string) string

+ type AbortInput struct

+ func NewAbortInput(senderKey, message string, sentAt time.Time, replyTo OutputDestination) *AbortInput

+ func (ai *AbortInput) Message() string

+ func (ai *AbortInput) ReplyTo() OutputDestination

+ func (ai *AbortInput) SenderKey() string

+ func (ai *AbortInput) SentAt() time.Time

+ type Adapter interface

+ BotType func() BotType

+ Run func(context.Context, func(Input) error, func(error))

+ SendMessage func(context.Context, Output)

+ type Alerter interface

+ Alert func(context.Context, BotType, error) error

+ type BlockedInputError struct

+ ContinuationCount int

+ func (e BlockedInputError) Error() string

+ type Bot interface

+ AppendCommand func(Command)

+ BotType func() BotType

+ Respond func(context.Context, Input) error

+ Run func(context.Context, func(Input) error, func(error))

+ SendMessage func(context.Context, Output)

+ func NewBot(adapter Adapter, options ...DefaultBotOption) (Bot, error)

+ type BotNonContinuableError struct

+ func (e BotNonContinuableError) Error() string

+ type BotType string

+ func (botType BotType) String() string

+ type CacheConfig struct

+ CleanupInterval time.Duration

+ ExpiresIn time.Duration

+ func NewCacheConfig() *CacheConfig

+ type Command interface

+ Execute func(context.Context, Input) (*CommandResponse, error)

+ Identifier func() string

+ InputExample func() string

+ Match func(Input) bool

+ type CommandConfig interface

+ type CommandHelp struct

+ Identifier string

+ InputExample string

+ type CommandHelps []*CommandHelp

+ type CommandProps struct

+ type CommandPropsBuilder struct

+ func NewCommandPropsBuilder() *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) BotType(botType BotType) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) Build() (*CommandProps, error)

+ func (builder *CommandPropsBuilder) ConfigurableFunc(config CommandConfig, ...) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) Func(fn func(context.Context, Input) (*CommandResponse, error)) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) Identifier(id string) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) InputExample(example string) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) MatchFunc(matchFunc func(Input) bool) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) MatchPattern(pattern *regexp.Regexp) *CommandPropsBuilder

+ func (builder *CommandPropsBuilder) MustBuild() *CommandProps

+ type CommandResponse struct

+ Content interface{}

+ UserContext *UserContext

+ func NewSuppressedResponseWithNext(next ContextualFunc) *CommandResponse

+ type Commands []Command

+ func NewCommands() *Commands

+ func (commands *Commands) Append(command Command)

+ func (commands *Commands) ExecuteFirstMatched(ctx context.Context, input Input) (*CommandResponse, error)

+ func (commands *Commands) FindFirstMatched(input Input) Command

+ func (commands *Commands) Helps() *CommandHelps

+ type Config struct

+ PluginConfigRoot string

+ TimeZone string

+ func NewConfig() *Config

+ type ContextualFunc func(context.Context, Input) (*CommandResponse, error)

+ type DefaultBotOption func(bot *defaultBot) error

+ func BotWithStorage(storage UserContextStorage) DefaultBotOption

+ type DestinatedConfig interface

+ DefaultDestination func() OutputDestination

+ type HelpInput struct

+ func NewHelpInput(senderKey, message string, sentAt time.Time, replyTo OutputDestination) *HelpInput

+ func (hi *HelpInput) Message() string

+ func (hi *HelpInput) ReplyTo() OutputDestination

+ func (hi *HelpInput) SenderKey() string

+ func (hi *HelpInput) SentAt() time.Time

+ type Input interface

+ Message func() string

+ ReplyTo func() OutputDestination

+ SenderKey func() string

+ SentAt func() time.Time

+ type Output interface

+ Content func() interface{}

+ Destination func() OutputDestination

+ func NewOutputMessage(destination OutputDestination, content interface{}) Output

+ type OutputDestination interface

+ type OutputMessage struct

+ func (output *OutputMessage) Content() interface{}

+ func (output *OutputMessage) Destination() OutputDestination

+ type Runner struct

+ func NewRunner(config *Config, options ...RunnerOption) (*Runner, error)

+ func (runner *Runner) Run(ctx context.Context)

+ type RunnerOption func(*Runner) error

+ func WithAlerter(alerter Alerter) RunnerOption

+ func WithBot(bot Bot) RunnerOption

+ func WithCommandProps(props *CommandProps) RunnerOption

+ func WithScheduledTask(botType BotType, task ScheduledTask) RunnerOption

+ func WithScheduledTaskProps(props *ScheduledTaskProps) RunnerOption

+ func WithWatcher(watcher watchers.Watcher) RunnerOption

+ func WithWorker(worker workers.Worker) RunnerOption

+ type RunnerOptions []RunnerOption

+ func NewRunnerOptions() *RunnerOptions

+ func (options *RunnerOptions) Append(opt RunnerOption)

+ func (options *RunnerOptions) Arg() RunnerOption

+ type ScheduledConfig interface

+ Schedule func() string

+ type ScheduledTask interface

+ DefaultDestination func() OutputDestination

+ Execute func(context.Context) ([]*ScheduledTaskResult, error)

+ Identifier func() string

+ Schedule func() string

+ type ScheduledTaskProps struct

+ type ScheduledTaskPropsBuilder struct

+ func NewScheduledTaskPropsBuilder() *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) BotType(botType BotType) *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) Build() (*ScheduledTaskProps, error)

+ func (builder *ScheduledTaskPropsBuilder) ConfigurableFunc(config TaskConfig, ...) *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) DefaultDestination(dest OutputDestination) *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) Func(fn func(context.Context) ([]*ScheduledTaskResult, error)) *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) Identifier(id string) *ScheduledTaskPropsBuilder

+ func (builder *ScheduledTaskPropsBuilder) MustBuild() *ScheduledTaskProps

+ func (builder *ScheduledTaskPropsBuilder) Schedule(schedule string) *ScheduledTaskPropsBuilder

+ type ScheduledTaskResult struct

+ Content interface{}

+ Destination OutputDestination

+ type SerializableArgument struct

+ Argument interface{}

+ FuncIdentifier string

+ type TaskConfig interface

+ type UserContext struct

+ Next ContextualFunc

+ Serializable *SerializableArgument

+ func NewUserContext(next ContextualFunc) *UserContext

+ type UserContextStorage interface

+ Delete func(string) error

+ Flush func() error

+ Get func(string) (ContextualFunc, error)

+ Set func(string, *UserContext) error

+ func NewUserContextStorage(config *CacheConfig) UserContextStorage

Other modules containing this package

github.com/oklahomer/go-sarah/v2

github.com/oklahomer/go-sarah/v3

github.com/oklahomer/go-sarah/v4