API Reference / API Parameters / enableRules

Jan. 14, 2021

enableRules

Type: boolean

Engine default: true

Parameter syntax

'enableRules' => true|false

enableRules: true|false

enableRules: true|false

'enableRules': True|False

enableRules = true|false

enableRules: Boolean = true|false

new JSONObject()
  .put("enableRules", true|false)

IndexSettings settings = new IndexSettings();
settings.EnableRules = true|false;

.setEnableRules(true|false)

opt.EnableRules(true|false)

enableRules = Some(true|false)

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

See code examples

About this parameter

Whether Rules should be globally enabled.

This is a global switch that affects all Rules.

Usage notes:

When true, Rules processing is enabled: Rules may match the query.
When false, Rules processing is disabled: no Rule will match the query.

Examples

Enable Rules by default

Copy

1
2
3
$index->setSettings([
  'enableRules' => true
]);

1
2
3
4
5
6
7
8
let settings = Settings()
  .set(\.enableRules, to: true)

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

Enable Rules for the current search

Copy

1
2
3
$results = $index->search('query', [
  'enableRules' => true
]);

1
2
3
4
5
6
7
8
let query = Query("query")
  .set(\.enableRules, to: true)

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

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

Building Search UI

PHP

Ruby

JavaScript

Python

Swift

Kotlin

Android

.NET

Java

Golang

Scala

InstantSearch.js

React InstantSearch

Vue InstantSearch

Angular InstantSearch

InstantSearch iOS

InstantSearch Android

Autocomplete

Crawler Configuration API

Index settings and search parameters

A full reference of API Endpoints

Rails

Symfony

Django

Laravel

Crawler

Magento 2

WordPress

Shopify

Salesforce Commerce Cloud B2C

Netlify

enableRules

About this parameter

Usage notes:

Examples

Enable Rules by default

Enable Rules for the current search

Did you find this page helpful?

On this page