Module | Guard::Notifier::Growl |
In: |
lib/guard/notifiers/growl.rb
|
System notifications using the [growl](github.com/visionmedia/growl) gem.
This gem is available for OS X and sends system notifications to [Growl](growl.info) through the [GrowlNotify](growl.info/downloads) executable.
The `growlnotify` executable must be installed manually or by using [Homebrew](mxcl.github.com/homebrew/).
Sending notifications with this notifier will not show the different Guard notifications in the Growl preferences. Use the :gntp or :growl_notify notifiers if you want to customize each notification type in Growl.
@example Install `growlnotify` with Homebrew
brew install growlnotify
@example Add the `growl` gem to your `Gemfile`
group :development gem 'growl' end
@example Add the `:growl` notifier to your `Guardfile`
notification :growl
@example Add the `:growl_notify` notifier with configuration options to your `Guardfile`
notification :growl, :sticky => true, :host => '192.168.1.5', :password => 'secret'
DEFAULTS | = | { :sticky => false, :priority => 0 | Default options for growl gem |
Test if the notification library is available.
@param [Boolean] silent true if no error messages should be shown @return [Boolean] the availability status
Show a system notification.
The documented options are for GrowlNotify 1.3, but the older options are also supported. Please see `growlnotify —help`.
Priority can be one of the following named keys: `Very Low`, `Moderate`, `Normal`, `High`, `Emergency`. It can also be an int between -2 and 2.
@param [String] type the notification type. Either ‘success’, ‘pending’, ‘failed’ or ‘notify’ @param [String] title the notification title @param [String] message the notification message body @param [String] image the path to the notification image @param [Hash] options additional notification library options @option options [Boolean] sticky make the notification sticky @option options [String, Integer] priority specify an int or named key (default is 0) @option options [String] host the hostname or IP address to which to send a remote notification @option options [String] password the password used for remote notifications