pushover

package

v0.8.0 Latest Latest Go to latest Published: Aug 20, 2023 License: MIT Imports: 9 Imported by: 0

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/containrrr/shoutrrr

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Config
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 ¶

View Source

const Scheme = "pushover"

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

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Config ¶

type Config struct {
	Token    string   `url:"pass" desc:"API Token/Key"`
	User     string   `url:"host" desc:"User Key"`
	Devices  []string `key:"devices" optional:""`
	Priority int8     `key:"priority" default:"0"`
	Title    string   `key:"title" optional:""`
}

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 (
	// UserMissing should be used when a config URL is missing a user
	UserMissing ErrorMessage = "user missing from config URL"
	// TokenMissing should be used when a config URL is missing a token
	TokenMissing ErrorMessage = "token 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

Source Files ¶

View all Source files

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