provider

package

v0.0.0-...-c531dcc Latest Latest Go to latest Published: May 31, 2018 License: MIT Imports: 4 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/DSchalla/Claptrap

Links

Open Source Insights

Documentation ¶

Index ¶

type Debug
- func NewDebug() *Debug
type Event
type Mattermost
- func NewMattermost(apiUrl, username, password, team string) *Mattermost
type Provider

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Debug ¶

type Debug struct {
	MessagePublicLog []messagePublicLog
	MessageUserLog   []messageUserLog
	InviteUserLog    []inviteUserLog
	KickUserLog      []kickUserLog
	DeleteMessageLog []deleteMessageLog
}

func NewDebug ¶

func NewDebug() *Debug

func (Debug) AutoJoinAllChannel ¶

func (Debug) AutoJoinAllChannel() bool

func (Debug) Connect ¶

func (Debug) Connect() bool

func (*Debug) DeleteMessage ¶

func (d *Debug) DeleteMessage(event Event) bool

func (Debug) GetEmailByUsername ¶

func (Debug) GetEmailByUsername(username string) string

func (Debug) GetEvents ¶

func (Debug) GetEvents() <-chan Event

func (*Debug) InviteUser ¶

func (d *Debug) InviteUser(userID, channelID string) bool

func (Debug) IsAlive ¶

func (Debug) IsAlive() bool

func (*Debug) KickUser ¶

func (d *Debug) KickUser(userID, channelID string) bool

func (Debug) ListenForEvents ¶

func (Debug) ListenForEvents()

func (*Debug) MessagePublic ¶

func (d *Debug) MessagePublic(channelID, message string) bool

func (*Debug) MessageUser ¶

func (d *Debug) MessageUser(userID, message string) bool

func (Debug) Reconnect ¶

func (Debug) Reconnect() bool

func (Debug) ReplaceMessagePlaceholders ¶

func (Debug) ReplaceMessagePlaceholders(event Event, message string) string

type Event ¶

type Event struct {
	Type        string
	PostID      string
	UserID      string
	UserName    string
	UserRole    string
	ActorID     string
	ActorName   string
	ActorRole   string
	ChannelID   string
	ChannelName string
	ChannelType string
	Text        string
	Timestamp   int64
}

type Mattermost ¶

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

func NewMattermost ¶

func NewMattermost(apiUrl, username, password, team string) *Mattermost

func (*Mattermost) AutoJoinAllChannel ¶

func (m *Mattermost) AutoJoinAllChannel() bool

func (*Mattermost) Connect ¶

func (m *Mattermost) Connect() bool

func (*Mattermost) DeleteMessage ¶

func (m *Mattermost) DeleteMessage(event Event) bool

func (*Mattermost) GetEmailByUsername ¶

func (m *Mattermost) GetEmailByUsername(username string) string

func (*Mattermost) GetEvents ¶

func (m *Mattermost) GetEvents() <-chan Event

func (*Mattermost) InviteUser ¶

func (m *Mattermost) InviteUser(userID, channelID string) bool

func (*Mattermost) IsAlive ¶

func (m *Mattermost) IsAlive() bool

ToDo: Implement IsAlive handler

func (*Mattermost) KickUser ¶

func (m *Mattermost) KickUser(userID, channelID string) bool

func (*Mattermost) ListenForEvents ¶

func (m *Mattermost) ListenForEvents()

func (*Mattermost) MessagePublic ¶

func (m *Mattermost) MessagePublic(channelID, message string) bool

func (*Mattermost) MessageUser ¶

func (m *Mattermost) MessageUser(userID, message string) bool

func (*Mattermost) Reconnect ¶

func (m *Mattermost) Reconnect() bool

func (*Mattermost) ReplaceMessagePlaceholders ¶

func (m *Mattermost) ReplaceMessagePlaceholders(event Event, message string) string

type Provider ¶

type Provider interface {
	Connect() bool
	Reconnect() bool
	IsAlive() bool
	ListenForEvents()
	GetEvents() <-chan Event
	AutoJoinAllChannel() bool

	// Get Information
	GetEmailByUsername(username string) string

	// Actions
	MessagePublic(channelID, message string) bool
	MessageUser(userID, message string) bool
	InviteUser(userID, channelID string) bool
	KickUser(userID, channelID string) bool
	DeleteMessage(event Event) bool
	ReplaceMessagePlaceholders(event Event, message string) string
}

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL