Consequence class final

Annotations

• @JsonSerializable.new()

Constructors

Consequence({ConsequenceParams? params, Iterable? promote, bool? filterPromotes, List<ConsequenceHide>? hide, ConsequenceRedirect? redirect, Object? userData})

Returns a new Consequence instance.

const

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

factory

Properties

filterPromotes → bool?

Determines whether promoted records must also match active filters for the consequence to apply. This ensures user-applied filters take priority and irrelevant matches aren't shown. For example, if you promote a record with color: red but the user filters for color: blue, the "red" record won't be shown. > In the Algolia dashboard, when you use the Pin an item consequence, filterPromotes appears as the checkbox: Pinned items must match active filters to be displayed. For examples, see Promote results with rules.

final

hashCode → int

The hash code for this object.

no setter, override

hide → List<ConsequenceHide>?

Records you want to hide from the search results.

final

params → ConsequenceParams?

final

promote → Iterable?

Records you want to pin to a specific position in the search results. You can promote up to 300 records, either individually, or as groups of up to 100 records each. One of types:

final

redirect → ConsequenceRedirect?

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

userData → Object?

A JSON object with custom data that will be appended to the userData array in the response. This object isn't interpreted by the API and is limited to 1 kB of minified JSON.

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