shoutrrr: github.com/containrrr/shoutrrr/pkg/services/join Index | Files

package join

import "github.com/containrrr/shoutrrr/pkg/services/join"

Index

Package Files

join.go join_config.go join_errors.go

Constants

const Scheme = "join"

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

type Config Uses

type Config struct {
    APIKey  string
    Devices []string
    Title   string
    Icon    string
}

Config for the Pushover notification service service

func (*Config) Enums Uses

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) Get Uses

func (config *Config) Get(key string) (string, error)

Get returns the value of a Query field

func (*Config) GetURL Uses

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

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

func (*Config) QueryFields Uses

func (config *Config) QueryFields() []string

QueryFields returns the fields that are part of the Query of the service URL

func (*Config) Set Uses

func (config *Config) Set(key string, value string) error

Set updates the value of a Query field

func (*Config) SetURL Uses

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

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

type ErrorMessage Uses

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 Uses

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

Service providing the notification service Pushover

func (*Service) Initialize Uses

func (service *Service) Initialize(configURL *url.URL, logger *log.Logger) error

Initialize loads ServiceConfig from configURL and sets logger for this Service

func (*Service) Send Uses

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

Send a notification message to Pushover

Package join imports 9 packages (graph) and is imported by 1 packages. Updated 2020-07-10. Refresh now. Tools for package owners.