notify

README

go.notify

An abstraction library for notifications. It provides following implementations:

• freedesktop
  An implementation of the Desktop Notifications Specification.

• gntp
  An implementation of the Growl Notification Transport Protocol.

• windows
  An implementation for the Windows Notifications.

Installation

$ go get -u github.com/hattya/go.notify

License

go.notify is distributed under the terms of the MIT License.

Credits

The Go gopher was designed by Renne French.

Documentation

Overview

Package notify provides an interface for notifications.

Index

• Variables
• type Icon
• type Notifier

Variables

var ErrEvent = errors.New("notify: unknown event")

Types

type Icon

type Icon interface{}

Icon represents an icon. Its value is dependent on each implementation.

type Notifier

type Notifier interface {
	// Close closes the Notifier.
	Close() error

	// Register registers the named event to the Notifier. The keys and values
	// of the opts are dependent on each implementation.
	//
	// Notifier may use the icon for notifications.
	Register(event string, icon Icon, opts map[string]interface{}) error

	// Notify notifies the named event by the specified title and body.
	Notify(event, title, body string) error

	// Sys returns the implementation of the Notifier.
	Sys() interface{}
}

Notifier is an interface for notifications.