Documentation
¶
Index ¶
- func JSON(ref interface{}) string
- func JSONBlock(ref interface{}) string
- type Bot
- func (b *Bot) DM(userID, format string, args ...interface{}) error
- func (b *Bot) DMWithAttachments(userID string, attachments ...*model.SlackAttachment) error
- func (b *Bot) Debugf(format string, args ...interface{})
- func (b *Bot) Ephemeral(userID, channelID, format string, args ...interface{})
- func (b *Bot) Errorf(format string, args ...interface{})
- func (b *Bot) Infof(format string, args ...interface{})
- func (b *Bot) PostMessage(channelID, format string, args ...interface{}) (string, error)
- func (b *Bot) PublishWebsocketEventToChannel(event string, payload interface{}, channelID string)
- func (b *Bot) PublishWebsocketEventToTeam(event string, payload interface{}, teamID string)
- func (b *Bot) PublishWebsocketEventToUser(event string, payload interface{}, userID string)
- func (b *Bot) Timed() Logger
- func (b *Bot) Warnf(format string, args ...interface{})
- func (b *Bot) With(logContext LogContext) Logger
- type LogContext
- type Logger
- type NilLogger
- func (l *NilLogger) Debugf(format string, args ...interface{})
- func (l *NilLogger) Errorf(format string, args ...interface{})
- func (l *NilLogger) Infof(format string, args ...interface{})
- func (l *NilLogger) Timed() Logger
- func (l *NilLogger) Warnf(format string, args ...interface{})
- func (l *NilLogger) With(logContext LogContext) Logger
- type Poster
- type TestLogger
- func (l *TestLogger) Debugf(format string, args ...interface{})
- func (l *TestLogger) Errorf(format string, args ...interface{})
- func (l *TestLogger) Infof(format string, args ...interface{})
- func (l *TestLogger) Timed() Logger
- func (l *TestLogger) Warnf(format string, args ...interface{})
- func (l *TestLogger) With(logContext LogContext) Logger
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type Bot ¶
type Bot struct {
// contains filtered or unexported fields
}
Bot stores the information for the plugin configuration, and implements the Poster and Logger interfaces.
func (*Bot) DMWithAttachments ¶
func (b *Bot) DMWithAttachments(userID string, attachments ...*model.SlackAttachment) error
DMWithAttachments posts a Direct Message that contains Slack attachments. Often used to include post actions.
func (*Bot) PostMessage ¶
PostMessage posts a message to a specified channel.
func (*Bot) PublishWebsocketEventToChannel ¶
PublishWebsocketEventToChannel sends a websocket event with payload to channelID
func (*Bot) PublishWebsocketEventToTeam ¶
PublishWebsocketEventToTeam sends a websocket event with payload to teamID
func (*Bot) PublishWebsocketEventToUser ¶
PublishWebsocketEventToUser sends a websocket event with payload to userID
type Logger ¶
type Logger interface {
With(LogContext) Logger
Timed() Logger
Debugf(format string, args ...interface{})
Errorf(format string, args ...interface{})
Infof(format string, args ...interface{})
Warnf(format string, args ...interface{})
}
Logger interface - a logging system that will tee logs to a DM channel.
type Poster ¶
type Poster interface {
// PostMessage posts a simple Direct Message to the specified user. Returns the post id if posting was successful
PostMessage(channelID, format string, args ...interface{}) (createdPostID string, err error)
// DM posts a simple Direct Message to the specified user.
DM(userID, format string, args ...interface{}) error
// DMWithAttachments posts a Direct Message that contains Slack attachments.
// Often used to include post actions.
DMWithAttachments(userID string, attachments ...*model.SlackAttachment) error
// Ephemeral sends an ephemeral message to a user.
Ephemeral(userID, channelID, format string, args ...interface{})
// PublishWebsocketEventToTeam sends a websocket event with payload to teamID.
PublishWebsocketEventToTeam(event string, payload interface{}, teamID string)
// PublishWebsocketEventToChannel sends a websocket event with payload to channelID.
PublishWebsocketEventToChannel(event string, payload interface{}, channelID string)
// PublishWebsocketEventToUser sends a websocket event with payload to userID.
PublishWebsocketEventToUser(event string, payload interface{}, userID string)
}
Poster interface - a small subset of the plugin posting API.
type TestLogger ¶
TestLogger test logger.
func (*TestLogger) Debugf ¶
func (l *TestLogger) Debugf(format string, args ...interface{})
Debugf .
func (*TestLogger) Errorf ¶
func (l *TestLogger) Errorf(format string, args ...interface{})
Errorf .