EnumPropertyOptions class

The options for enum properties, which allow you to define a restricted set of strings to match user queries, set rankings for those string values, and define an operator name to be paired with those strings so that users can narrow results to only items with a specific value.

For example, for items in a request tracking system with priority information, you could define p0 as an allowable enum value and tie this enum to the operator name priority so that search users could add priority:p0 to their query to restrict the set of results to only those items indexed with the value p0.

Constructors

EnumPropertyOptions({EnumOperatorOptions? operatorOptions, String? orderedRanking, List<EnumValuePair>? possibleValues})
EnumPropertyOptions.fromJson(Map json_)

Properties

hashCode int
The hash code for this object.
no setterinherited
operatorOptions EnumOperatorOptions?
If set, describes how the enum should be used as a search operator.
getter/setter pair
orderedRanking String?
Used to specify the ordered ranking for the enumeration that determines how the integer values provided in the possible EnumValuePairs are used to rank results.
getter/setter pair
possibleValues List<EnumValuePair>?
The list of possible values for the enumeration property.
getter/setter pair
runtimeType Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() Map<String, dynamic>
toString() String
A string representation of this object.
inherited

Operators

operator ==(Object other) bool
The equality operator.
inherited