gnotifier

README

gnotifier

A Go lib for sending desktop notifications on Linux and Mac OS X 10.8+

Documentation

Index

• type Builder
• type Config
  • func (c *Config) IsValid() error
• type GNotifier
  • func Notification(title, message string) GNotifier
  • func NullNotification(title, message string) GNotifier
• type TestRecorder
  • func NewTestRecorder() *TestRecorder
  • func (r *TestRecorder) Notification(title, message string) GNotifier

Types

type Builder

type Builder func(title, message string) GNotifier

Builder abstracts the concrete function Notification

type Config

type Config struct {
	Title           string
	Message         string
	Expiration      int32
	ApplicationName string
}

Config define the notification options

func (*Config) IsValid

func (c *Config) IsValid() error

type GNotifier

type GNotifier interface {
	Push() error
	GetConfig() *Config
	IsValid() error
}

GNotifier interface

func Notification

func Notification(title, message string) GNotifier

Notification is the builder

func NullNotification

func NullNotification(title, message string) GNotifier

NullNotification is the builder for tests where no side effects are desired

type TestRecorder

type TestRecorder struct {
	Pushed []*Config
}

TestRecorder provides a way to verify the GNotifier api use (not intended for production code)

func NewTestRecorder

func NewTestRecorder() *TestRecorder

NewTestRecorder constructs a new TestRecorder. Use its Notification method as test Builder.

func (*TestRecorder) Notification

func (r *TestRecorder) Notification(title, message string) GNotifier