Consequence
algoliasearch.search.Consequence
case class Consequence(params: Option[ConsequenceParams], promote: Option[Seq[Promote]], filterPromotes: Option[Boolean], hide: Option[Seq[ConsequenceHide]], userData: Option[Any])
Consequences of a rule.
Value parameters
- filterPromotes
-
Only use in combination with the
promote
consequence. Whentrue
, promoted results will be restricted to match the filters of the current search. Whenfalse
, the promoted results will show up regardless of the filters. - hide
-
Records to hide. By default, you can hide up to 50 records per rule.
- promote
-
Records to promote.
- userData
-
Custom JSON object that will be appended to the userData array in the response. This object isn't interpreted by the API. It's limited to 1kB of minified JSON.
Attributes
- Graph
-
- Supertypes
-
trait Serializabletrait Producttrait Equalsclass Objecttrait Matchableclass Any
Members list
In this article