\Horde_Core_Alarm_Handler_Notify

A Horde_Alarm handler that notifies of active alarms over the Horde_Notification system.

Summary

Methods
Properties
Constants
notify()
getDescription()
getParameters()
No public properties found
No constants found
No protected methods found
$_soundPlayed
N/A
No private methods found
No private properties found
N/A

Properties

$_soundPlayed

$_soundPlayed : boolean

Whether a sound already had been played during the page request.

Type

boolean

Methods

notify()

notify(array  $alarm) 

Notifies about an alarm through Horde_Notification.

Parameters

array $alarm

An alarm hash.

getDescription()

getDescription() : string

Returns a human readable description of the handler.

Returns

string

getParameters()

getParameters() : array

Returns a hash of user-configurable parameters for the handler.

The parameters are hashes with parameter names as keys and parameter information as values. The parameter information is a hash with the following keys:

  • desc: a parameter description.
  • required: whether this parameter is required.
  • type: the parameter type as a preference type.

Returns

array