| Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |
Properties
Name | Type | Description |
---|---|---|
info P | AlarmInfo |
Information about this alarm.
|
Properties inherited from ExtensibleManagedObject | ||
availableField, value |
Methods
Methods defined in this Managed Object |
---|
ReconfigureAlarm, RemoveAlarm |
Methods inherited from ExtensibleManagedObject |
setCustomValue |
In addition to the Alarm.Edit privilege, may also require the Global.ScriptAction if a RunScriptAction action is specified in the AlarmSpec.
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Alarm used to make the method call. |
spec | AlarmSpec |
The new specification for the alarm.
|
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
DuplicateName | Thrown if an alarm with the name already exists. |
InvalidArgument | Thrown if the specification is invalid. |
InvalidName | Thrown if the alarm name is empty or too long. |
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Parameters
Name | Type | Description |
---|---|---|
_this | ManagedObjectReference | A reference to the Alarm used to make the method call. |
Return Value
Type | Description |
---|---|
None |
Faults
Type | Description |
---|---|
RuntimeFault | Thrown if any type of runtime fault is thrown that is not covered by the other faults; for example, a communication error. |
Events
Type | |
---|---|
None |
Top of page | Local Properties | Local Methods | |
Managed Object Types | Data Object Types | All Properties | All Methods |