notify

type Action ¶ added in v0.11.0

type Action struct {
	Key   string
	Label string
}

Action holds key and label for user action buttons.

type ActionInvokedHandler ¶ added in v0.9.0

type ActionInvokedHandler func(*ActionInvokedSignal)

ActionInvokedHandler is called when we receive a signal that one of the action_keys was invoked.

Note that invoking an action often also produces a NotificationClosedSignal, so you might receive both a Closed signal and a ActionInvoked signal.

I suspect this detail is implementation specific for the UI interaction, and does at least happen on XFCE4.

type ActionInvokedSignal ¶

type ActionInvokedSignal struct {
	// ID of the Notification the action was invoked for
	ID uint32
	// Key from the tuple (action_key, label)
	ActionKey string
}

ActionInvokedSignal holds data from any signal received regarding Actions invoked

type Notification ¶

type Notification struct {
	AppName string
	// Setting ReplacesID atomically replaces the notification with this ID.
	// Optional.
	ReplacesID uint32
	// See predefined icons here: http://standards.freedesktop.org/icon-naming-spec/icon-naming-spec-latest.html
	// Optional.
	AppIcon string
	Summary string
	Body    string
	// Actions are tuples of (action_key, label), e.g.: []Action{"cancel", "Cancel", "open", "Open"}
	Actions []Action
	Hints   map[string]dbus.Variant
	// ExpireTimeout: duration to show notification. See also ExpireTimeoutSetByNotificationServer and ExpireTimeoutNever.
	ExpireTimeout time.Duration
}

Notification holds all information needed for creating a notification

type NotificationClosedHandler ¶ added in v0.9.0

type NotificationClosedHandler func(*NotificationClosedSignal)

NotificationClosedHandler is called when we receive a NotificationClosed signal

type NotificationClosedSignal ¶

type NotificationClosedSignal struct {
	// ID of the Notification the signal was invoked for
	ID uint32
	// A reason given if known
	Reason Reason
}

NotificationClosedSignal holds data for *Closed callbacks from Notifications Interface.

type Notifier ¶

type Notifier interface {
	SendNotification(n Notification) (uint32, error)
	GetCapabilities() ([]string, error)
	GetServerInformation() (ServerInformation, error)
	CloseNotification(id uint32) (bool, error)
	Close() error
}

Notifier is an interface implementing the operations supported by the Freedesktop DBus Notifications object.

New() sets up a Notifier that listens on dbus' signals regarding Notifications: NotificationClosed and ActionInvoked.

Signal delivery works by subscribing to all signals regarding Notifications, which means you will see signals for Notifications also from other sources, not just the latest you sent

Users that only want to send a simple notification, but don't care about interacting with signals, can use exported method: SendNotification(conn, Notification)

Caller is responsible for calling Close() before exiting, to shut down event loop and cleanup dbus registration.

func New(conn *dbus.Conn, opts ...option) (Notifier, error)

type Reason ¶

type Reason uint32

Reason for the closed notification

const (
	// ReasonExpired when a notification expired
	ReasonExpired Reason = 1

	// ReasonDismissedByUser when a notification has been dismissed by a user
	ReasonDismissedByUser Reason = 2

	// ReasonClosedByCall when a notification has been closed by a call to CloseNotification
	ReasonClosedByCall Reason = 3

	// ReasonUnknown when as notification has been closed for an unknown reason
	ReasonUnknown Reason = 4
)

func (r Reason) String() string

type ServerInformation ¶

type ServerInformation struct {
	Name        string
	Vendor      string
	Version     string
	SpecVersion string
}

ServerInformation is a holder for information returned by GetServerInformation call.

func GetServerInformation(conn *dbus.Conn) (ServerInformation, error)

 GetServerInformation Return Values

		Name		 Type	  Description
		name		 STRING	  The product name of the server.
		vendor		 STRING	  The vendor name. For example, "KDE," "GNOME," "freedesktop.org," or "Microsoft."
		version		 STRING	  The server's version number.
		spec_version STRING	  The specification version the server is compliant with.