SearchRulesParams class final

Annotations
  • @JsonSerializable()

Constructors

SearchRulesParams.new({String? query, Anchoring? anchoring, String? context, int? page, int? hitsPerPage, bool? enabled})
Returns a new SearchRulesParams instance.
const
SearchRulesParams.fromJson(Map<String, dynamic> json)
factory

Properties

anchoring → Anchoring?
final
context → String?
Only return rules that match the context (exact match).
final
enabled → bool?
If true, return only enabled rules. If false, return only inactive rules. By default, all rules are returned.
final
hashCode → int
The hash code for this object.
no setteroverride
hitsPerPage → int?
Maximum number of hits per page. Algolia uses page and hitsPerPage to control how search results are displayed (paginated). - hitsPerPage: sets the number of search results (hits) displayed per page. - page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on. For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.
final
page → int?
Requested page of the API response. Algolia uses page and hitsPerPage to control how search results are displayed (paginated). - hitsPerPage: sets the number of search results (hits) displayed per page. - page: specifies the page number of the search results you want to retrieve. Page numbering starts at 0, so the first page is page=0, the second is page=1, and so on. For example, to display 10 results per page starting from the third page, set hitsPerPage to 10 and page to 2.
final
query → String?
Search query for rules.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
override

Operators

operator ==(Object other) → bool
The equality operator.
override