Rule class final

Annotations

• @JsonSerializable()

Constructors

Rule({required String objectID, List<Condition>? conditions, Consequence? consequence, String? description, bool? enabled, List<TimeRange>? validity})

Returns a new Rule instance.

const

Rule.fromJson(Map<String, dynamic> json)

factory

Properties

conditions → List<Condition>?

Conditions required to activate a rule. You can use up to 25 conditions per rule.

final

consequence → Consequence?

final

description → String?

Description of the rule's purpose. This can be helpful for display in the Algolia dashboard.

final

enabled → bool?

Indicates whether to enable the rule. If it isn't enabled, it isn't applied at query time.

final

hashCode → int

The hash code for this object.

no setter, override

objectID → String

Unique identifier for a rule object.

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

validity → List<TimeRange>?

If you specify a validity period, the rule only applies only during that period. If specified, the array must not be empty.

final

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.

override

Operators

operator ==(Object other) → bool

The equality operator.

override