Consequence

algoliasearch.search.Consequence

case class Consequence(params: Option[ConsequenceParams], promote: Option[Seq[Promote]], filterPromotes: Option[Boolean], hide: Option[Seq[ConsequenceHide]], userData: Option[Any])

Effect of the rule. For more information, see Consequences.

Value parameters

filterPromotes: Whether promoted records must match an active filter for the consequence to be applied. This ensures that user actions (filtering the search) are given a higher precendence. For example, if you promote a record with the color: red attribute, and the user filters the search for color: blue, the "red" record won't be shown.
hide: Records you want to hide from the search results.
promote: 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.
userData: 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.

Graph
Supertypes: trait Serializable

trait Product

trait Equals

class Object

trait Matchable

class Any
Show all

In this article

Generated with