SearchQuery class

SearchQuery describes a search query.

Annotations

• @freezed

Constructors

SearchQuery({required String indexPath, required String accessKey, required int limit, required String text, List<Field>? filters, List<String>? select, List<String>? searchFields, @Default('') String? cursor})

Default Constructor

const

factory

SearchQuery.fromJson(Map<String, dynamic> json)

Unmarshalls from json to SeachQuery

factory

Properties

accessKey → String

AccessKey authenticates the request. Get an AccessKey from the AccessKeyService.GenerateKey method.

no setter, inherited

copyWith → $SearchQueryCopyWith<SearchQuery>

no setter, inherited

cursor → String?

Cursor is a encoded string from a previous Query, that you can use to get more results.

no setter, inherited

filters → List<Field>?

Filters are a list of where filters to apply when performing the search.

no setter, inherited

hashCode → int

The hash code for this object.

no setter, inherited

indexPath → String

IndexPath is the path of the index to search.

no setter, inherited

limit → int

Limit is the maximum number of search results to return. Smaller limits are faster.

no setter, inherited

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

searchFields → List<String>?

SearchFields is a list of fields to search. If empty, all fields will be searched.

no setter, inherited

select → List<String>?

Select lists the fields to get from the document. Filters are automatically included. To get search fields out, they must have been put with store set to true.

no setter, inherited

text → String

Text contains a phrase to search for.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toJson() → Map<String, dynamic>

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited