Enumeration for the different possible validity states.
Members
No filters for this type
Constants
The candidate cannot be used to create a port, instead getPortCandidateAt needs to be called to obtain a IPortCandidate that is either VALID or INVALID.
The candidate cannot be used to create a port, instead getPortCandidateAt needs to be called to obtain a IPortCandidate that is either VALID or INVALID.
static
See Also
Developer's Guide
Static Methods
Converts the given argument to an enum constant of this enum type.
Converts the given argument to an enum constant of this enum type.
Most notably, this method can convert an enum constant's name into the enum constant itself.
static
Parameters
- value: PortCandidateValidity
- The value to convert to an enum constant.
Return Value
- PortCandidateValidity
- The enum constant that corresponds to the given argument.
Returns the name of the given enum constant.
Returns the name of the given enum constant.
static
Parameters
- value: PortCandidateValidity
- The numeric value of an enum constant.
Return Value
- string
- The name of the enum constant.
Throws
- Exception ({ name: 'Error' })
- If this type is a flags enums, and the provided value doesn't correspond to a single enum constant, or if this enum type contains no constant of the given numeric value.