system.alarm.getShelvedPaths
Description
Returns a list of the current shelved alarm paths. A "path" may be either a source path, or a display path.
Syntax
system.alarm.getShelvedPaths()
-
Parameters
Nothing
-
Returns
List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.
-
Scope
All, Client, or Gateway
Examples
Code Snippet
#The following code prints a list of the shelved alarms paths and prints them to the console.
paths
=
system.alarm.getShelvedPaths()
for
p
in
paths:
print
"Path: %s, Shelved by: %s, expires: %s, is expired? %s"
%
(p.getPath(), p.getUser(), p.getExpiration(), p.isExpired())