Module | Guard::Notifier::GNTP |
In: |
lib/guard/notifiers/gntp.rb
|
System notifications using the [ruby_gntp](github.com/snaka/ruby_gntp) gem.
This gem is available for OS X, Linux and Windows and sends system notifications to the following system notification frameworks through the [Growl Network Transport Protocol](www.growlforwindows.com/gfw/help/gntp.aspx):
@example Add the `ruby_gntp` gem to your `Gemfile`
group :development gem 'ruby_gntp' end
@example Add the `:gntp` notifier to your `Guardfile`
notification :gntp
@example Add the `:gntp` notifier with configuration options to your `Guardfile`
notification :gntp, :sticky => true, :host => '192.168.1.5', :password => 'secret'
DEFAULTS | = | { :sticky => false, :host => '127.0.0.1', :password => '', :port => 23053 | Default options for the ruby gtnp gem |
Test if the notification library is available.
@param [Boolean] silent true if no error messages should be shown @param [Hash] options notifier options @return [Boolean] the availability status
Show a system notification.
@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 [String] host the hostname or IP address to which to send a remote notification @option options [String] password the password used for remote notifications @option options [Integer] port the port to send a remote notification @option options [Boolean] sticky make the notification sticky