Alarm-objektet
Alarm-objektet representerar ett enskilt alarm i serverkonfigurationen.
Egenskaper i Alarm-objekt
AcknowledgeRule
Är en sträng innehållande aktuell regel för kvittering.
Acknowledged
Är en boolean som är true (sann) om alarmet är kvitterat, annars är den false (falsk).
AlarmGroup
Är en sträng innehållande aktuell larmgrupp.
AssociatedCameras
Är en vektor som innehåller alla kameror som är associerade med alarmet.
Blocked
Är en boolean som är true (sann) om alarmet är blockerat, annars är den false (falsk).
Description
Är en sträng innehållande aktuell beskrivning.
IsCameraAlarm
Är en boolean som är true (sann) om alarmet har associerade kameror, annars är den false (falsk).
IsSystemAlarm
Är en boolean som är true (sann) om alarmet saknar associerade kameror, annars är den false (falsk).
IsUserDefined
Är en boolean som är true (sann) om alarmet är egendefinierat, annars är den false (falsk).
LastState
Är en number som innehåller föregående State för alarmet.
Name
Är en sträng innehållande namnet.
NumAssociatedCameras
Är en number som innehåller hur många kameror som är associerade med alarmet.
Parent
Är det objekt som äger larmet eller larmet själv om det är användardefinierat.
PrimaryCamera
Är ett kameraobjekt för den kamera som är markerad som primär (för bockad).
Severity
Är en number som innehåller vilken allvarlighet som där definierad.
State
Är en number som innehåller aktuell status. 0 Inactive, 1 Acked, 2 Unacked, 3 Active, 4 Blocked.
Text
Är en sträng innehållande definierad text.
Metoder i Alarm-objektet
Acknowledge()
Denna metod används för att kvittera alarmet.
Returvärde är en sträng med datum och tid för statusförändringen.
Block()
Denna metod används för att blockera alarmet.
Returvärde är en sträng med datum och tid för statusförändringen.
GetActiveTime()
Denna metod används för att returnera tiden för när alarmet senast aktiverades.
Returvärde är en sträng med datum och tid för statusförändringen.
GetTime()
Denna metod används för att returnera tiden för senaste status förändringen för alarmet.
Returvärde är en sträng med datum och tid för statusförändringen.
SetActive([tsLocalTime])
Denna metod används för att aktivera alarmet. Du kan skicka med en sträng eller ett datumobjekt med lokal tid för när larmet ska aktiveras (upp till 500ms före nutid).
Returvärde är en sträng med datum och tid för statusförändringen i lokal tid.
SetActiveUTC([tsUTCTime])
Denna metod används för att aktivera alarmet. Du kan skicka med en sträng eller ett datumobjekt i UTC-tid för när larmet ska aktiveras (upp till 500ms före nutid).
Returvärde är en sträng med datum och tid för statusförändringen i lokal tid.
SetInactive()
Denna metod används för att inaktivera alarmet.
Returvärde är en sträng med datum och tid för statusförändringen.
Unblock()
Denna metod används för att avblockera alarmet.
Returvärde är en sträng med datum och tid för statusförändringen.
Events i Alarm-objektet
Alarm-objektet har följande events:
onStateChange(event)
Varje alarm i datalagret kan generera ett event när något har hänt med alarmet. I detta fall är det statusförändringar, till exempel aktiverat, kvitterat osv.
Detta exempel visar hur State har förändrats på ett alarm när en förändring sker.
VaultOpenTooLong.onStateChange = function(event)
{
Debug.Print(event.target.Name + " " + event.target.LastState + " -> " + event.target.State);
}
Här skriver vi ut alarmets namn, föregående status och nuvarande status.
Eventargumentet event har en egenskap förutom standard Javascript event argument egenskaper:
target – en referens till alarm-objektet. Här ges tillgång till alla alarmobjektets egenskaper såsom Name, Text och många fler som listats ovan.