API reference
API reference
Select your platform
No SDKs available
No versions available

ByEnumFilterOperation Class

Modifiers: final
A class representing a filter operation for Enum attributes. It is used to build a filter expression by specifying comparison and pattern matching operations on string attribute values.
Example: 
// Find entities where enumVar equals TestEnum.FOO
Query.where { has(TestComponent.id) }
     .filter { by(TestComponent.enumVarData).isEqualTo(TestEnum.FOO) }

Signature

class ByEnumFilterOperation(val attrId: Int, val filterBuilder: FilterBuilder)

Constructors

ByEnumFilterOperation ( attrId , filterBuilder ) : ByEnumFilterOperation
Signature 
constructor(attrId: Int, filterBuilder: FilterBuilder)
Parameters
attrId: Int
The attribute id of the filter operation.
filterBuilder: FilterBuilder
The filter builder object used to create the filter node.
Returns

Properties

attrId : Int
[Get]
Signature 
val attrId: Int
filterBuilder : FilterBuilder
[Get]
Signature 
val filterBuilder: FilterBuilder

Functions

isEqualTo ( enumValue ) : ByIntFilterNode
Creates a filter node representing an equality condition with the given Enum value.
Signature 
fun isEqualTo(enumValue: Enum<*>): ByIntFilterNode
Parameters
enumValue: Enum
Returns
A filter node representing the equality condition.
Did you find this page helpful?
Thumbs up icon
Thumbs down icon
Nav Logo
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
Virtual reality / Meta Horizon
English (US)
© 2026 Meta