slack

Documentation

Index

• func Signature(signingSecret string, ts time.Time, data []byte) string
• type Channel
• type ChannelSender
  • func NewChannelSender(ctx context.Context, cfg Config) (*ChannelSender, error)
  • func (s *ChannelSender) Channel(ctx context.Context, channelID string) (*Channel, error)
  • func (s *ChannelSender) DMSender() *DMSender
  • func (s *ChannelSender) ListChannels(ctx context.Context) ([]Channel, error)
  • func (s *ChannelSender) ListUserGroups(ctx context.Context) ([]UserGroup, error)
  • func (s *ChannelSender) Send(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)
  • func (s *ChannelSender) ServeMessageAction(w http.ResponseWriter, req *http.Request)
  • func (s *ChannelSender) SetReceiver(r notification.Receiver)
  • func (s *ChannelSender) Team(ctx context.Context, id string) (t *Team, err error)
  • func (s *ChannelSender) TeamID(ctx context.Context) (string, error)
  • func (s *ChannelSender) User(ctx context.Context, id string) (*User, error)
  • func (s *ChannelSender) UserGroup(ctx context.Context, id string) (*UserGroup, error)
  • func (s *ChannelSender) UserGroupSender() *UserGroupSender
• type Config
• type DMSender
  • func (s *DMSender) FriendlyValue(ctx context.Context, id string) (string, error)
• type Team
  • func (t Team) ChannelLink(id string) string
  • func (t Team) UserLink(id string) string
• type User
• type UserGroup
• type UserGroupSender
  • func (s *UserGroupSender) Send(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)

Functions

func Signature

func Signature(signingSecret string, ts time.Time, data []byte) string

Signature generates a signature for a Slack request.

Types

type Channel

type Channel struct {
	ID     string
	Name   string
	TeamID string
}

Channel contains information about a Slack channel.

type ChannelSender

type ChannelSender struct {
	// contains filtered or unexported fields
}

func NewChannelSender

func NewChannelSender(ctx context.Context, cfg Config) (*ChannelSender, error)

func (*ChannelSender) Channel

func (s *ChannelSender) Channel(ctx context.Context, channelID string) (*Channel, error)

Channel will lookup a single Slack channel for the bot.

func (*ChannelSender) DMSender

func (s *ChannelSender) DMSender() *DMSender

DMSender returns a new DMSender wrapping the given ChannelSender.

func (*ChannelSender) ListChannels

func (s *ChannelSender) ListChannels(ctx context.Context) ([]Channel, error)

ListChannels will return a list of channels visible to the slack bot.

func (*ChannelSender) ListUserGroups

func (s *ChannelSender) ListUserGroups(ctx context.Context) ([]UserGroup, error)

ListUserGroups will return a list of all Slack user groups.

func (*ChannelSender) Send

func (s *ChannelSender) Send(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)

func (*ChannelSender) ServeMessageAction

func (s *ChannelSender) ServeMessageAction(w http.ResponseWriter, req *http.Request)

func (*ChannelSender) SetReceiver

func (s *ChannelSender) SetReceiver(r notification.Receiver)

func (*ChannelSender) Team

func (s *ChannelSender) Team(ctx context.Context, id string) (t *Team, err error)

func (*ChannelSender) TeamID

func (s *ChannelSender) TeamID(ctx context.Context) (string, error)

func (*ChannelSender) User

func (s *ChannelSender) User(ctx context.Context, id string) (*User, error)

User will lookup a single Slack user.

func (*ChannelSender) UserGroup

func (s *ChannelSender) UserGroup(ctx context.Context, id string) (*UserGroup, error)

User will lookup a single Slack user group.

func (*ChannelSender) UserGroupSender

func (s *ChannelSender) UserGroupSender() *UserGroupSender

UserGroupSender returns a new UserGroupSender wrapping the given ChannelSender.

type Config

type Config struct {
	BaseURL   string
	UserStore *user.Store
}

Config contains values used for the Slack notification sender.

type DMSender

type DMSender struct {
	*ChannelSender
}

DMSender wraps a ChannelSender with DM-specific functionality.

func (*DMSender) FriendlyValue

func (s *DMSender) FriendlyValue(ctx context.Context, id string) (string, error)

FriendlyValue implements notification.FriendlyValuer returning the `@`-handle of the given Slack user ID.

type Team

type Team struct {
	ID      string
	Domain  string
	Name    string
	IconURL string
}

Team contains information about a Slack team.

func (Team) ChannelLink

func (t Team) ChannelLink(id string) string

func (Team) UserLink

func (t Team) UserLink(id string) string

type User

type User struct {
	ID     string
	Name   string
	TeamID string
}

User contains information about a Slack user.

type UserGroup

type UserGroup struct {
	ID     string
	TeamID string
	Name   string
	Handle string
}

type UserGroupSender

type UserGroupSender struct {
	*ChannelSender
}

UserGroupSender processes on-call notifications by updating the members of a Slack user group.

func (*UserGroupSender) Send

func (s *UserGroupSender) Send(ctx context.Context, msg notification.Message) (*notification.SentMessage, error)

Send implements notification.Sender.