chats

Documentation

Index

• Constants
• Variables
• func ProviderAccessTokenURL(kind string, url string) string
• type ChannelMetrics
  • func (m *ChannelMetrics) ToMarkdown() string
• type ChatProvider
  • func CreateChatProvider(kind string, server *auth.AuthServer, userAuth *auth.UserAuth, batchMode bool) (ChatProvider, error)
  • func CreateSlackChatProvider(server *auth.AuthServer, userAuth *auth.UserAuth, batchMode bool) (ChatProvider, error)
• type SlackChatProvider
  • func (c *SlackChatProvider) GetChannelMetrics(name string) (*ChannelMetrics, error)

Constants

const (
	Slack = "slack"
	Irc   = "irc"
)

Variables

var (
	ChatKinds = []string{Slack, Irc}
)

Functions

func ProviderAccessTokenURL

func ProviderAccessTokenURL(kind string, url string) string

Types

type ChannelMetrics

type ChannelMetrics struct {
	ID          string
	Name        string
	URL         string
	MemberCount int
	Members     []string
}

ChannelMetrics metrics for a channel

func (*ChannelMetrics) ToMarkdown

func (m *ChannelMetrics) ToMarkdown() string

type ChatProvider

type ChatProvider interface {
	GetChannelMetrics(name string) (*ChannelMetrics, error)
}

ChatProvider represents an integration interface to chat

func CreateChatProvider

func CreateChatProvider(kind string, server *auth.AuthServer, userAuth *auth.UserAuth, batchMode bool) (ChatProvider, error)

CreateChatProvider creates a new chat provider if one is available for the given kind

func CreateSlackChatProvider

func CreateSlackChatProvider(server *auth.AuthServer, userAuth *auth.UserAuth, batchMode bool) (ChatProvider, error)

type SlackChatProvider

type SlackChatProvider struct {
	SlackClient *slack.Client
	Server      *auth.AuthServer
	UserAuth    *auth.UserAuth
}

func (*SlackChatProvider) GetChannelMetrics

func (c *SlackChatProvider) GetChannelMetrics(name string) (*ChannelMetrics, error)