Search Rules

index.search_rules(
  String query,
  Hash opts = {
    anchoring: String,
    context: String,
    page: Integer,
    hitsPerPage: Integer,
    enabled: Boolean
  }
)

index.searchRules(string query)

index.searchRules(string query, {
  // All the following parameters are optional
  anchoring => string,
  context => string,
  page => integer,
  hitsPerPage => integer,
  enabled => boolean,
  // any other requestOptions
})

index.search_rules(str query, {
    // All the following parameters are optional
    'anchoring': str,
    'context': str,
    'page': int,
    'hitsPerPage': int,
    'enabled': bool
})

index.searchRules(
  _ query: RuleQuery,
  requestOptions: RequestOptions? = nil,
  completion: Result<RuleSearchResponse> -> Void
)

struct RuleQuery {
  var query: String? = nil
  var anchoring: Rule.Anchoring? = nil
  var context: String? = nil
  var page: Int? = nil
  var hitsPerPage: Int? = nil
  var isEnabled: Bool? = nil
}

suspend fun Index.searchRules(
  query: RuleQuery = RuleQuery(),
  requestOptions: RequestOptions? = null
): ResponseSearchRules

@Serializable
data class RuleQuery(
    var query: String? = null,
    var anchoring: Anchoring? = null,
    var context: String? = null,
    var page: Int? = null,
    var hitsPerPage: Int? = null,
    var enabled: Boolean? = null
)

This method is not available in mobile API clients.

Query Rules need to be configured via
the Algolia Dashboard or with one of our backend API clients.

index.SearchRules(
  new RuleQuery
  {
    Query = String,
    Anchoring = String,
    Context = String,
    Page = int,
    HitsPerPage = int,
    Enabled = bool,
  })

index.searchRules(
  new RuleQuery(String query)
    .setAnchoring(String anchoring)
    .setContext(String context)
    .setPage(int page)
    .setHitsPerPage(int hitsPerPage)
    .setEnabled(bool enabled)
)

index.SearchRules(string query)
index.SearchRules(
  string query,
  opt.Anchoring(string anchoring),
  opt.RuleContexts(string context),
  opt.Page(int page),
  opt.HitsPerPage(int hitsPerPage),
  opt.EnableRules(bool enabled),
)

search.rules(in).index("indexName").query(
  QueryRules(
    query = String,
    anchoring = String,
    context = String,
    page = int,
    hitsPerPage = int,
    enabled = bool,
  )
)