SearchResponse class

SearchResponse is the output object for Search.

Annotations
  • @freezed

Constructors

SearchResponse({SearchQuery? searchQuery, List<SearchResult>? hits, @Default(0) int? duration, String? cursor, @Default(false) bool? more, @Default('') String? error})
Default Constructor
const
factory
SearchResponse.fromJson(Map<String, dynamic> json)
Unmarshalls json to SearchResponse
factory

Properties

copyWith → $SearchResponseCopyWith<SearchResponse>
no setterinherited
cursor String?
Cursor is a encoded string that you can pass to a new Query to get more results.
no setterinherited
duration int?
Duration is the milliseconds that the search took to execute in the server side
no setterinherited
error String?
Error is string explaining what went wrong. Empty if everything was fine.
no setterinherited
hashCode int
The hash code for this object.
no setterinherited
hits List<SearchResult>?
Hits are the search results.
no setterinherited
more bool?
More indicates that there may be more search results. If true, make the same Search request passing this Cursor. For performance reasons, Firesearch doesn't always know with certainty so it's possible the subsequent request will return
no setterinherited
runtimeType Type
A representation of the runtime type of the object.
no setterinherited
searchQuery SearchQuery?
Query is the SearchQuery that generated these results.
no setterinherited

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