MessageSearchQuery class
A class representing query to retrieve list of BaseMessages that matches a given query with given filters. @since 4.0.13
Constructors
- MessageSearchQuery.new({required String keyword, Chat? chat})
Properties
- advancedQuery ↔ bool
-
Whether the search query should be an advanced query or not.
@since 4.0.13
getter/setter pair
- channelCustomType ↔ String?
-
The custom type of channel to set as the search scope.
@since 4.0.13
getter/setter pair
- channelUrl ↔ String?
-
The channel url to set as the search scope.
@since 4.0.13
getter/setter pair
- chat → Chat
-
finalinherited
- exactMatch ↔ bool
-
Whether the search query should be an exact match or not.
@since 4.0.13
getter/setter pair
- hashCode → int
-
The hash code for this object.
no setterinherited
- hasNext ↔ bool
-
Whether there is a next page.
getter/setter pairinherited
- isLoading ↔ bool
-
Whether the current query is in communication progress with server.
getter/setter pairinherited
- keyword ↔ String
-
The keyword to search for.
@since 4.0.13
getter/setter pair
- limit ↔ int
-
The maximum number of items per queried page.
getter/setter pairinherited
- messageTimestampFrom ↔ int?
-
The start message timestamp set as the search range.
@since 4.0.13
getter/setter pair
- messageTimestampTo ↔ int?
-
The end message timestamp set as the search range.
@since 4.0.13
getter/setter pair
- order ↔ MessageSearchQueryOrder
-
The MessageSearchQueryOrder of the search.
@since 4.0.13
getter/setter pair
- reverse ↔ bool
-
Whether the search result is set to be reversed or not.
@since 4.0.13
getter/setter pair
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
targetFields
↔ List<
String> -
Target fields of the query to set as the search scope.
@since 4.0.13
getter/setter pair
- token ↔ String?
-
getter/setter pairinherited
- totalCount ↔ int
-
The total count of results that matches the given search.
@since 4.0.13
getter/setter pair
Methods
-
next(
) → Future< List< BaseMessage> > -
Gets the list of next items.
@since 4.0.13
override
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited