ruleContexts

Type: list of strings

Engine default: []

Parameter syntax

'ruleContexts' => [
  'context_value',
  ...
]

ruleContexts: [
  'context_value',
  ...
]

ruleContexts: [
  'context_value',
  ...
]

'ruleContexts': [
  'context_value',
  ...
]

ruleContexts = [
  "context_value",
  ...
]

ruleContexts {
    +"context_value"
    +...
}

.RuleContexts(
  new List<string> {
    "context_value",
    ...
  }
)

.setRuleContexts(
  Arrays.asList(
    "context_value",
    ...
  )
)

opt.RuleContexts(
  "context_value",
  ...
)

ruleContexts = Some(Seq(
  "context_value",
  ...
))

Can be used in these methods:
search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey search, browse_objects, search_for_facet_values, generate_secured_api_key, add_api_key, update_api_key search, browse, searchForFacetValues, generateSecuredApiKey, addAPIKey, updateAPIKey search, browseObjects, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, Browse, SearchForFacetValues, GenerateSecuredApiKey, AddApiKey, UpdateApiKey Search, browse, searchForFacetValues, generateSecuredApiKey, addApiKey, updateApiKey Search, BrowseObjects, SearchForFacetValues, GenerateSecuredAPIKey, AddAPIKey, UpdateAPIKey search, browse index, search into facet values, generateSecuredApiKey, add key, update key

See code examples

About this parameter

Assigns rule contexts to search queries.

This parameter enables previously created rule contexts. Contexts control whether a rule should apply all the time or only in some situations. For example, contexts can be used to apply rules based on:

Mobile or desktop device usage
Landing or category pages
User interactions—for example, with facets
Dates, such as promotional periods like Black Friday
Languages, such as French and English
Countries, such as Germany and Austria

You can also assign rule contexts with InstantSearch:

InstantSearch Use the `queryRuleContext` widget to apply contexts (JavaScript)

Use the `useQueryRules` Hook to apply contexts (React)

Use the `queryRuleContext` widget to apply contexts (Vue)

Use the `queryRuleContext` widget to apply contexts (Angular)

Usage notes

Contexts can only contain alphanumeric characters, hyphens, and underscores.
If ruleContexts is empty, only non-contextual rules are activated.
You can pass up to 10 different contexts to the API at once (at query time).

Examples

Specify rule contexts for the current query

Copy

1
2
3
4
5
6
$results = $index->search('query', [
  'ruleContexts' => [
    'front_end',
    'website2'
  ]
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.ruleContexts, to: ["front_end", "website2"])

index.search(query: query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
client.execute {
  search into "myIndex" query Query(
    query = Some("query"),
    ruleContexts = Some(Seq(
      "front_end",
      "website2"
    ))
  )
}

Did you find this page helpful?

ruleContexts

About this parameter

Usage notes

Examples

Specify rule contexts for the current query

On this page