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

none

Returns

List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.

Scope

All

system.alarm.getShelvedPaths()

Parameters

none

Returns

List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.

Scope

Client

system.alarm.getShelvedPaths()

Parameters

none

Returns

List - A list of ShelvedPath objects. ShelvedPath objects can be examined with getExpiration, getHitCount, getPath, getShelveTime, getUser, and isExpired.

Scope

Gateway

Examples

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())