new Alarm()
constructor
- Source:
Methods
doesAlarmingForBasedataExist(basedataId, namespace, callback)
Checks if there exists an entry in database for the combination of basedataId and namespace
Parameters:
Name |
Type |
Description |
basedataId |
integer
|
id of basedata entry |
namespace |
string
|
namespace of plugin |
callback |
function
|
existing (true or false) |
- Source:
getAllAlarmings(callback)
returns list of all alarmings as rows
Parameters:
Name |
Type |
Description |
callback |
function
|
rows or null |
- Source:
getAllAlarmingUUIDsForNamespace(namespace, callback)
Returns an array of basedata UUIDs for the selected plugin namespace
Parameters:
Name |
Type |
Description |
namespace |
string
|
plugin namespace for which UUIDs of basedata shall be returned |
callback |
function
|
one dimensional array of basedata uuids |
- Source:
removeAlarmingForBasedata(basedataId, namespace, callback)
Removes an alarming from table
Parameters:
Name |
Type |
Description |
basedataId |
integer
|
basedata id |
namespace |
string
|
namespace of plugin |
callback |
function
|
success (true or false) |
- Source:
sendTestAlarmForBasedataAndNamespace(basedataId, namespace, alarmInfo, callback)
Send out a test alarm for only one user via one plugin
Parameters:
Name |
Type |
Description |
basedataId |
integer
|
basedataId of user for whom this test alarm shall be sent out |
namespace |
*
|
namespace of plugin the alarm shall be processed by |
alarmInfo |
*
|
operations-object containing the alarm information |
callback |
*
|
success(true/false) |
- Source:
setAlarmForBasedata(basedataId, namespace, callback)
Parameters:
Name |
Type |
Description |
basedataId |
integer
|
basedata id of basedata entry the alarming shall be persisted for |
namespace |
string
|
namespace of plugin, the alarming shall be registeres for |
callback |
function
|
success (true or false) |
- Source: