matrix

Documentation

Index

• Constants
• type Config
  • func (c *Config) GetURL() *url.URL
  • func (c *Config) SetURL(url *url.URL) error
• type Service
  • func (s *Service) Initialize(configURL *url.URL, logger t.StdLogger) error
  • func (s *Service) Send(message string, params *t.Params) error

Constants

const Scheme = "matrix"

Scheme is the identifying part of this service's configuration URL

Types

type Config

type Config struct {
	standard.EnumlessConfig

	User       string   `optional:"" url:"user" desc:"Username or empty when using access token"`
	Password   string   `url:"password" desc:"Password or access token"`
	DisableTLS bool     `key:"disableTLS" default:"No"`
	Host       string   `url:"host"`
	Rooms      []string `key:"rooms,room" optional:"" desc:"Room aliases, or with ! prefix, room IDs"`
	Title      string   `key:"title" default:""`
}

Config is the configuration for the matrix service

func (*Config) GetURL

func (c *Config) GetURL() *url.URL

GetURL returns a URL representation of it's current field values

func (*Config) SetURL

func (c *Config) SetURL(url *url.URL) error

SetURL updates a ServiceConfig from a URL representation of it's field values

type Service

type Service struct {
	standard.Standard
	// contains filtered or unexported fields
}

Service providing Matrix as a notification service

func (*Service) Initialize

func (s *Service) Initialize(configURL *url.URL, logger t.StdLogger) error

Initialize loads ServiceConfig from configURL and sets logger for this Service

func (*Service) Send

func (s *Service) Send(message string, params *t.Params) error

Send notification