comms

Documentation

Index

• type Comms
  • func NewComms(c config.Config) *Comms
  • func (c Comms) CommsSend(system CommsSystem, creds CommsCredentials, commsPackage CommsPackage) error
  • func (c Comms) SendComms(commsPackage CommsPackage) error
• type CommsCredentials
• type CommsPackage
• type CommsStorage
  • func NewCommsStorage(c config.Config) *CommsStorage
  • func (c CommsStorage) FetchCredentials(a agent.Agent) (CommsCredentials, error)
• type CommsSystem
• type Communication
  • func NewCommunication(config config.Config) *Communication
  • func (c Communication) AttachCommsHandler(w http.ResponseWriter, r *http.Request)
  • func (c Communication) CreateCommsHandler(w http.ResponseWriter, r *http.Request)
  • func (c Communication) DeleteCommsHandler(w http.ResponseWriter, r *http.Request)
  • func (c Communication) DetachCommsHandler(w http.ResponseWriter, r *http.Request)
  • func (c Communication) ListCommsHandler(w http.ResponseWriter, r *http.Request)
• type Credentials
• type Discord
  • func NewDiscord(c config.Config) *Discord
  • func (d *Discord) Connect() error
  • func (d *Discord) ParseCredentials(creds interface{}) error
  • func (d *Discord) Send(commsPackage CommsPackage) error
• type DiscordCredentials
• type Slack
  • func NewSlack(c config.Config) *Slack
  • func (s *Slack) Connect() error
  • func (s *Slack) ParseCredentials(creds interface{}) error
  • func (s *Slack) Send(commsPackage CommsPackage) error
• type SlackCredentials

Types

type Comms

type Comms struct {
	Config config.Config
}

func NewComms

func NewComms(c config.Config) *Comms

func (Comms) CommsSend

func (c Comms) CommsSend(system CommsSystem, creds CommsCredentials, commsPackage CommsPackage) error

func (Comms) SendComms

func (c Comms) SendComms(commsPackage CommsPackage) error

type CommsCredentials

type CommsCredentials struct {
	Agent        agent.Agent `json:"agent_id"`
	CommsDetails interface{} `json:"comms_details"`
	System       string      `json:"system"`
}

type CommsPackage

type CommsPackage struct {
	Agent        agent.Agent
	Message      string
	Link         string
	TicketSystem string
}

type CommsStorage

type CommsStorage struct {
	Config  config.Config
	Context context.Context
}

func NewCommsStorage

func NewCommsStorage(c config.Config) *CommsStorage

func (CommsStorage) FetchCredentials

func (c CommsStorage) FetchCredentials(a agent.Agent) (CommsCredentials, error)

type CommsSystem

type CommsSystem interface {
	Connect() error

	ParseCredentials(interface{}) error

	Send(cp CommsPackage) error
}

type Communication

type Communication struct {
	Config config.Config
}

func NewCommunication

func NewCommunication(config config.Config) *Communication

func (Communication) AttachCommsHandler

func (c Communication) AttachCommsHandler(w http.ResponseWriter, r *http.Request)

func (Communication) CreateCommsHandler

func (c Communication) CreateCommsHandler(w http.ResponseWriter, r *http.Request)

func (Communication) DeleteCommsHandler

func (c Communication) DeleteCommsHandler(w http.ResponseWriter, r *http.Request)

func (Communication) DetachCommsHandler

func (c Communication) DetachCommsHandler(w http.ResponseWriter, r *http.Request)

func (Communication) ListCommsHandler

func (c Communication) ListCommsHandler(w http.ResponseWriter, r *http.Request)

type Credentials

type Credentials struct {
	AgentID string `json:"agent_id"`
}

type Discord

type Discord struct {
	BotAuth string

	Context     context.Context
	Credentials DiscordCredentials
	Config      config.Config
}

func NewDiscord

func NewDiscord(c config.Config) *Discord

func (*Discord) Connect

func (d *Discord) Connect() error

func (*Discord) ParseCredentials

func (d *Discord) ParseCredentials(creds interface{}) error

func (*Discord) Send

func (d *Discord) Send(commsPackage CommsPackage) error

type DiscordCredentials

type DiscordCredentials struct {
	Channel string `json:"channel"`
	Credentials
}

type Slack

type Slack struct {
	Client *slack.Client

	Context     context.Context
	Credentials SlackCredentials
	Config      config.Config
}

func NewSlack

func NewSlack(c config.Config) *Slack

func (*Slack) Connect

func (s *Slack) Connect() error

func (*Slack) ParseCredentials

func (s *Slack) ParseCredentials(creds interface{}) error

func (*Slack) Send

func (s *Slack) Send(commsPackage CommsPackage) error

type SlackCredentials

type SlackCredentials struct {
	Channel string `json:"channel"`
	Token   string `json:"token"`
	Credentials
}