channels

Documentation

Index

• type Channel
• type Channels
  • func New(channelsConfig *Config) *Channels
• type Config
  • func LoadConfig(path string) (*Config, error)

Types

type Channel

type Channel interface {
	// ReceiveMessage from the channel
	ReceiveMessage(body []byte) (*messages.Receive, error)
	// ReceiveMessages from the channel. Starts a long running process, receives questions and sends them to the receiveChan
	ReceiveMessages(receiveChan chan messages.Receive)
	// SendMessage to the channel
	SendMessage(response *messages.Response) error
	// ValidateCallback validates a callback to the channel
	ValidateCallback(r *http.Request) bool
	// String returns the channel's name
	String() string
}

Channel interface implements a channel to send and receive messages on

type Channels

type Channels struct {
	Telegram Channel
	Twilio   Channel
	REST     Channel
	Slack    Channel
}

Channels combines all available channel clients

func New

func New(channelsConfig *Config) *Channels

New initializes all channels

type Config

type Config struct {
	Telegram telegram.Config `mapstructure:"telegram"`
	Twilio   twilio.Config   `mapstructure:"twilio"`
	Slack    slack.Config    `mapstructure:"slack"`
	REST     rest.Config     `mapstructure:"rest"`
}

Config struct combines all available client configurations

func LoadConfig

func LoadConfig(path string) (*Config, error)

LoadConfig loads channels configuration from chn.yml