module Libnotify

Exposes a list of icon directories to resolve `icon_path`.

@see Libnotify.show

@example

Libnotify.icon_dirs << "/usr/share/icons/gnome/*/"
Libnotify.show(:icon_path => "emblem-default.png")

@return Array<String> list of icon directories

# File lib/libnotify.rb, line 78
def self.icon_dirs
  API.icon_dirs
end

Creates a notification.

@example Block syntax

n = Libnotify.new do |notify|
  notify.summary    = "hello"
  notify.body       = "world"
  notify.timeout    = 1.5         # 1.5 (s), 1000 (ms), "2", nil, false
  notify.urgency    = :critical   # :low, :normal, :critical
  notify.append     = false       # default true - append onto existing notification
  notify.transient  = true        # default false - keep the notifications around after display
  notify.icon_path  = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
end
n.show!

@example Hash syntax

Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)

@example Update pre-existing notification then close it

n = Libnotify.new(:summary => "hello", :body => "world")
n.update # identical to show! if not shown before
Kernel.sleep 1
n.update(:body => "my love") do |notify|
  notify.summary = "goodbye"
end
Kernel.sleep 1
n.close

@example Mixed syntax

Libnotify.new(options) do |n|
  n.timeout = 1.5     # overrides :timeout in options
  n.show!
end

@param [Hash] options options creating a notification @option options [String] :app_name ('Libnotify::API') name of the application @option options [String] :summary (' ') summary/title of the notification @option options [String] :body (' ') the body @option options [Fixnum, Float, nil, FalseClass, String] :timeout (nil) display duration of the notification.

Use +false+ or +nil+ for no timeout.

@option options [Symbol] :urgency (:normal) the urgency of the notification.

Possible values are: +:low+, +:normal+ and +:critical+

@option options [String] :icon_path path the an icon displayed.

@yield [notify] passes the notification object @yieldparam [API] notify the notification object

@return [API] the notification object

# File lib/libnotify.rb, line 58
def self.new(options = {}, &block)
  API.new(options, &block)
end

Shows a notification. It takes the same options as Libnotify.new.

@see Libnotify.new

# File lib/libnotify.rb, line 65
def self.show(options = {}, &block)
  API.show(options, &block)
end