join

Documentation

Index

• Constants
• type Config
  • func (config *Config) Enums() map[string]types.EnumFormatter
  • func (config *Config) GetURL() *url.URL
  • func (config *Config) SetURL(url *url.URL) error
• type ErrorMessage
• type Service
  • func (service *Service) Initialize(configURL *url.URL, logger types.StdLogger) error
  • func (service *Service) Send(message string, params *types.Params) error

Constants

const Scheme = "join"

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

Types

type Config

type Config struct {
	APIKey  string   `url:"pass"`
	Devices []string `key:"devices" desc:"Comma separated list of device IDs"`
	Title   string   `key:"title" optional:"" desc:"If set creates a notification"`
	Icon    string   `key:"icon" optional:"" desc:"Icon URL"`
}

Config for the Pushover notification service service

func (*Config) Enums

func (config *Config) Enums() map[string]types.EnumFormatter

Enums returns the fields that should use a corresponding EnumFormatter to Print/Parse their values

func (*Config) GetURL

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

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

func (*Config) SetURL

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

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

type ErrorMessage

type ErrorMessage string

ErrorMessage for error events within the pushover service

const (
	// APIKeyMissing should be used when a config URL is missing a token
	APIKeyMissing ErrorMessage = "API key missing from config URL"

	// DevicesMissing should be used when a config URL is missing devices
	DevicesMissing ErrorMessage = "devices missing from config URL"
)

type Service

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

Service providing the notification service Pushover

func (*Service) Initialize

func (service *Service) Initialize(configURL *url.URL, logger types.StdLogger) error

Initialize loads ServiceConfig from configURL and sets logger for this Service

func (*Service) Send

func (service *Service) Send(message string, params *types.Params) error

Send a notification message to Pushover