Enumerated Types Overview

An enumerated type (“enumeration”) stores a specific set of pre-defined values. Enumerated data types serve the same purpose as constants. For example, a SmsTaskState enumerated type comprises a set of three constants that can be used to convey the list of possible states of a task:

• error
• running
• success

Enumerated type values can be passed to or returned by the operations of a managed object. Properties of managed objects or data objects may also be defined using enumerated types.

All enumerations are listed in the frame at the left of this page. Click a name to display the reference documentation for the enumeration. Reference documentation for enumerated types typically includes:

• Description of purpose and usage.
• A list of valid enum constant values.

The list to the left is a simple alphabetical list of all enumerations.

To quickly find documentation for a specific enumerated data type, enter its name in the Quick Index.