slack

Documentation

Index

• type Slack
  • func New(cfg *transport.Config) (*Slack, error)
  • func (s *Slack) Channels() ([]*transport.Channel, error)
  • func (s *Slack) GetConversation(userID string) (string, error)
  • func (s *Slack) GetUser(user string) (*transport.User, error)
  • func (s *Slack) GetUsers() ([]*transport.User, error)
  • func (s *Slack) SendEvent(ev *transport.Event) error
  • func (s *Slack) SendMessage(dest, msg string) error
  • func (s *Slack) TunnelEvents(ctx context.Context, evCh chan *transport.Event, errCh chan error)

Types

type Slack

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

Slack provides io access to the Slack network.

func New

func New(cfg *transport.Config) (*Slack, error)

New returns a new instance of Slack. cfg.IgnoreUsers must be set with the bot name or ID otherwise it will potentially read it's own messages.

func (*Slack) Channels

func (s *Slack) Channels() ([]*transport.Channel, error)

Channels lists all the channels we have access to.

func (*Slack) GetConversation

func (s *Slack) GetConversation(userID string) (string, error)

GetConversation gets a private conversation for the given user ID.

func (*Slack) GetUser

func (s *Slack) GetUser(user string) (*transport.User, error)

GetUser returns the full user data for the provided name or ID.

func (*Slack) GetUsers

func (s *Slack) GetUsers() ([]*transport.User, error)

GetUsers returns a list of all known users.

func (*Slack) SendEvent

func (s *Slack) SendEvent(ev *transport.Event) error

SendEvent sends a new event to Slack.

func (*Slack) SendMessage

func (s *Slack) SendMessage(dest, msg string) error

SendMessage sends a message using the default format.

func (*Slack) TunnelEvents

func (s *Slack) TunnelEvents(ctx context.Context, evCh chan *transport.Event, errCh chan error)

TunnelEvents translates Slack events to transport.Events tunneling them into evCh. The session is terminated when ctx.Done returns.