slacker

package module

Go to main page

Versions in this module

v1

v1.4.1

Mar 29, 2023

Changes in this version

type BotContext

+ APIClient func() *slack.Client

type InteractiveBotContext

+ APIClient func() *slack.Client

type JobContext

+ APIClient func() *slack.Client

type Slacker

+ func (s *Slacker) APIClient() *slack.Client

v1.4.0

Mar 28, 2023

Changes in this version

type BotContext

+ ApiClient func() *slack.Client

+ SocketModeClient func() *socketmode.Client

+ type Command interface

+ Definition func() *CommandDefinition

+ Execute func(BotContext, Request, ResponseWriter)

+ Interactive func(InteractiveBotContext, *socketmode.Request, *slack.InteractionCallback)

+ Match func(string) (*proper.Properties, bool)

+ Tokenize func() []*commander.Token

+ Usage func() string

+ func NewCommand(usage string, definition *CommandDefinition) Command

+ type InteractiveBotContext interface

+ ApiClient func() *slack.Client

+ Context func() context.Context

+ Event func() *socketmode.Event

+ SocketModeClient func() *socketmode.Client

+ func NewInteractiveBotContext(ctx context.Context, apiClient *slack.Client, ...) InteractiveBotContext

+ type Job interface

+ Callback func(JobContext) func()

+ Definition func() *JobDefinition

+ Spec func() string

+ func NewJob(spec string, definition *JobDefinition) Job

+ type JobContext interface

+ ApiClient func() *slack.Client

+ Context func() context.Context

+ SocketModeClient func() *socketmode.Client

+ func NewJobContext(ctx context.Context, apiClient *slack.Client, ...) JobContext

+ type JobDefinition struct

+ Description string

+ Handler func(JobContext)

+ HideHelp bool

type MessageEvent

+ ChannelID string

+ UserID string

+ UserProfile *slack.UserProfile

+ func NewMessageEvent(slacker *Slacker, event interface{}, req *socketmode.Request) *MessageEvent

type ReportErrorOption

+ func WithThreadReplyError(useThread bool) ReportErrorOption

type ResponseWriter

+ Post func(channel string, message string, options ...ReplyOption) error

type Slacker

+ func (s *Slacker) ApiClient() *slack.Client

+ func (s *Slacker) CustomInteractiveBotContext(...)

+ func (s *Slacker) CustomJobContext(...)

+ func (s *Slacker) Job(spec string, definition *JobDefinition)

+ func (s *Slacker) SanitizeEventText(sanitizeEventText func(in string) string)

+ func (s *Slacker) SocketModeClient() *socketmode.Client

v1.3.1

Feb 18, 2023

v1.3.0

Aug 28, 2022

Changes in this version

type Slacker

+ func (s *Slacker) DefaultInnerEvent(...)

v1.2.0

Jul 26, 2022

Changes in this version

type CommandDefinition

+ Examples []string

v0

v0.1.1

Jul 16, 2022

v0.1.0

Jul 4, 2022

Changes in this version

type CommandDefinition

+ HideHelp bool

type Slacker

+ func (s *Slacker) CustomBotContext(...)

+ func (s *Slacker) CustomCommand(...)

v0.0.99

Jul 1, 2022

Changes in this version

+ type BotCommand interface

+ Definition func() *CommandDefinition

+ Execute func(botCtx BotContext, request Request, response ResponseWriter)

+ Interactive func(*Slacker, *socketmode.Event, *slack.InteractionCallback, *socketmode.Request)

+ Match func(text string) (*proper.Properties, bool)

+ Tokenize func() []*commander.Token

+ Usage func() string

+ func NewBotCommand(usage string, definition *CommandDefinition) BotCommand

+ type BotContext interface

+ Client func() *slack.Client

+ Context func() context.Context

+ Event func() *MessageEvent

+ SocketMode func() *socketmode.Client

+ func NewBotContext(ctx context.Context, client *slack.Client, socketmode *socketmode.Client, ...) BotContext

+ type BotInteractionMode int

+ const BotInteractionModeIgnoreAll

+ const BotInteractionModeIgnoreApp

+ const BotInteractionModeIgnoreNone

+ type ClientDefaults struct

+ BotMode BotInteractionMode

+ Debug bool

+ type ClientOption func(*ClientDefaults)

+ func WithBotInteractionMode(mode BotInteractionMode) ClientOption

+ func WithDebug(debug bool) ClientOption

+ type CommandDefinition struct

+ AuthorizationFunc func(botCtx BotContext, request Request) bool

+ BlockID string

+ Description string

+ Example string

+ Handler func(botCtx BotContext, request Request, response ResponseWriter)

+ Interactive func(*Slacker, *socketmode.Event, *slack.InteractionCallback, *socketmode.Request)

+ type CommandEvent struct

+ Command string

+ Event *MessageEvent

+ Parameters *proper.Properties

+ Timestamp time.Time

+ func NewCommandEvent(command string, parameters *proper.Properties, event *MessageEvent) *CommandEvent

+ type MessageEvent struct

+ BotID string

+ Channel string

+ ChannelName string

+ Data interface{}

+ Text string

+ ThreadTimeStamp string

+ TimeStamp string

+ Type string

+ User string

+ UserName string

+ func (e *MessageEvent) IsBot() bool

+ func (e *MessageEvent) IsThread() bool

+ type ReplyDefaults struct

+ Attachments []slack.Attachment

+ Blocks []slack.Block

+ ThreadResponse bool

+ func NewReplyDefaults(options ...ReplyOption) *ReplyDefaults

+ type ReplyOption func(*ReplyDefaults)

+ func WithAttachments(attachments []slack.Attachment) ReplyOption

+ func WithBlocks(blocks []slack.Block) ReplyOption

+ func WithThreadReply(useThread bool) ReplyOption

+ type ReportErrorDefaults struct

+ ThreadResponse bool

+ func NewReportErrorDefaults(options ...ReportErrorOption) *ReportErrorDefaults

+ type ReportErrorOption func(*ReportErrorDefaults)

+ func WithThreadError(useThread bool) ReportErrorOption

+ type Request interface

+ BooleanParam func(key string, defaultValue bool) bool

+ FloatParam func(key string, defaultValue float64) float64

+ IntegerParam func(key string, defaultValue int) int

+ Param func(key string) string

+ Properties func() *proper.Properties

+ StringParam func(key string, defaultValue string) string

+ func NewRequest(botCtx BotContext, properties *proper.Properties) Request

+ type ResponseWriter interface

+ Reply func(text string, options ...ReplyOption) error

+ ReportError func(err error, options ...ReportErrorOption)

+ func NewResponse(botCtx BotContext) ResponseWriter

+ type Slacker struct

+ func NewClient(botToken, appToken string, options ...ClientOption) *Slacker

+ func (s *Slacker) BotCommands() []BotCommand

+ func (s *Slacker) CleanEventInput(cei func(in string) string)

+ func (s *Slacker) Client() *slack.Client

+ func (s *Slacker) Command(usage string, definition *CommandDefinition)

+ func (s *Slacker) CommandEvents() <-chan *CommandEvent

+ func (s *Slacker) CustomRequest(...)

+ func (s *Slacker) CustomResponse(responseConstructor func(botCtx BotContext) ResponseWriter)

+ func (s *Slacker) DefaultCommand(...)

+ func (s *Slacker) DefaultEvent(defaultEventHandler func(interface{}))

+ func (s *Slacker) Err(errorHandler func(err string))

+ func (s *Slacker) GetUserInfo(user string) (*slack.User, error)

+ func (s *Slacker) Help(definition *CommandDefinition)

+ func (s *Slacker) Init(initHandler func())

+ func (s *Slacker) Interactive(...)

+ func (s *Slacker) Listen(ctx context.Context) error

+ func (s *Slacker) SocketMode() *socketmode.Client

+ func (s *Slacker) UnAuthorizedError(errUnauthorized error)

Other modules containing this package

github.com/shomali11/slacker/v2

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