slack

README

An Adapter implementation for Slack.

Documentation

Index

• func NewAdapter(provider data.SlackProvider) adapter.Adapter
• func ScrubMarkdown(text string) string
• type ClassicAdapter
  • func (s ClassicAdapter) GetChannelInfo(channelID string) (*adapter.ChannelInfo, error)
  • func (s ClassicAdapter) GetName() string
  • func (s ClassicAdapter) GetPresentChannels() ([]*adapter.ChannelInfo, error)
  • func (s ClassicAdapter) GetUserInfo(userID string) (*adapter.UserInfo, error)
  • func (s ClassicAdapter) Listen(ctx context.Context) <-chan *adapter.ProviderEvent
  • func (s ClassicAdapter) SendErrorMessage(channelID string, title string, text string) error
  • func (s ClassicAdapter) SendMessage(channelID string, text string) error
• type SocketModeAdapter
  • func (s *SocketModeAdapter) GetChannelInfo(channelID string) (*adapter.ChannelInfo, error)
  • func (s *SocketModeAdapter) GetName() string
  • func (s *SocketModeAdapter) GetPresentChannels() ([]*adapter.ChannelInfo, error)
  • func (s *SocketModeAdapter) GetUserInfo(userID string) (*adapter.UserInfo, error)
  • func (s *SocketModeAdapter) Listen(ctx context.Context) <-chan *adapter.ProviderEvent
  • func (s *SocketModeAdapter) SendErrorMessage(channelID string, title string, text string) error
  • func (s *SocketModeAdapter) SendMessage(channelID string, message string) error

Functions

func NewAdapter

func NewAdapter(provider data.SlackProvider) adapter.Adapter

NewAdapter will construct a SlackAdapter instance for a given provider configuration.

func ScrubMarkdown

func ScrubMarkdown(text string) string

ScrubMarkdown removes unnecessary/undesirable Slack markdown (of links, of example) from text received from Slack.

Types

type ClassicAdapter

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

ClassicAdapter is the Slack provider implementation of a relay, which knows how to receive events from the Slack API, translate them into Gort events, and forward them along.

func (ClassicAdapter) GetChannelInfo

func (s ClassicAdapter) GetChannelInfo(channelID string) (*adapter.ChannelInfo, error)

GetChannelInfo returns the ChannelInfo for a requested channel.

func (ClassicAdapter) GetName

func (s ClassicAdapter) GetName() string

GetName returns this adapter's configured name

func (ClassicAdapter) GetPresentChannels

func (s ClassicAdapter) GetPresentChannels() ([]*adapter.ChannelInfo, error)

GetPresentChannels returns a slice of channel ID strings that the Adapter is present in. This is expensive. Don't use it often.

func (ClassicAdapter) GetUserInfo

func (s ClassicAdapter) GetUserInfo(userID string) (*adapter.UserInfo, error)

GetUserInfo returns the UserInfo for a requested user.

func (ClassicAdapter) Listen

func (s ClassicAdapter) Listen(ctx context.Context) <-chan *adapter.ProviderEvent

Listen instructs the relay to begin listening to the provider that it's attached to. It exits immediately, returning a channel that emits ProviderEvents.

func (ClassicAdapter) SendErrorMessage

func (s ClassicAdapter) SendErrorMessage(channelID string, title string, text string) error

SendErrorMessage will send a message (from the bot) into the specified channel.

func (ClassicAdapter) SendMessage

func (s ClassicAdapter) SendMessage(channelID string, text string) error

SendMessage will send a message (from the bot) into the specified channel.

type SocketModeAdapter

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

SocketModeAdapter is the Slack provider implementation of a relay, which knows how to receive events from the Slack API, translate them into Gort events, and forward them along.

func (*SocketModeAdapter) GetChannelInfo

func (s *SocketModeAdapter) GetChannelInfo(channelID string) (*adapter.ChannelInfo, error)

GetChannelInfo provides info on a specific provider channel accessible to the adapter.

func (*SocketModeAdapter) GetName

func (s *SocketModeAdapter) GetName() string

GetName provides the name of this adapter as per the configuration.

func (*SocketModeAdapter) GetPresentChannels

func (s *SocketModeAdapter) GetPresentChannels() ([]*adapter.ChannelInfo, error)

GetPresentChannels returns a slice of channels that a user is present in.

func (*SocketModeAdapter) GetUserInfo

func (s *SocketModeAdapter) GetUserInfo(userID string) (*adapter.UserInfo, error)

GetUserInfo provides info on a specific provider user accessible to the adapter.

func (*SocketModeAdapter) Listen

func (s *SocketModeAdapter) Listen(ctx context.Context) <-chan *adapter.ProviderEvent

Listen causes the Adapter to initiate a connection to its provider and begin relaying back events (including errors) via the returned channel.

func (*SocketModeAdapter) SendErrorMessage

func (s *SocketModeAdapter) SendErrorMessage(channelID string, title string, text string) error

SendErrorMessage sends an error message to a specified channel. TODO Create a MessageBuilder at some point to replace this.

func (*SocketModeAdapter) SendMessage

func (s *SocketModeAdapter) SendMessage(channelID string, message string) error

SendMessage sends a standard output message to a specified channel. TODO Create a MessageBuilder at some point to replace this.