getEnum Method

Get the value as ECEnumeration value Note: This method is optional. Using ECSqlValue.getInteger for integral enums and ECSqlValue.getString for string enums respectively are the usual way to get enum values. This method can be used if the context of the underlying ECEnumeration is required. The value is broken down into the ECEnumerators that make it up, if the value is a combination of ECEnumerators. If the value is not a strict match of an ECEnumerator or a combination of them, undefined is returned.

Note: You can call ECSqlValue.columnInfo.isEnum to find out whether this method can be called or not.

getEnum(): ECEnumValue[] | undefined

Returns - ECEnumValue[] | undefined

ECEnumeration value(s) or undefined if the ECSqlValue does not represent an ECEnumeration. or is not a strict match of an ECEnumerator or a combination of them.

Defined in

• core/backend/src/ECSqlStatement.ts Line 613

Last Updated: 13 June, 2024