SearchMessages class final
Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
Returns FoundMessages.
- Inheritance
-
- Object
- TdFunction<
FoundMessages> - SearchMessages
Constructors
- SearchMessages({ChatList? chatList, required String query, required String offset, required int limit, SearchMessagesFilter? filter, required int minDate, required int maxDate})
-
Searches for messages in all chats except secret chats. Returns the results in reverse chronological order (i.e., in order of decreasing (date, chat_id, message_id)). For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
const
Properties
- canBeCalledSynchronously → bool
-
Whether TDLib documents this request as callable through
td_execute.no setterinherited - chatList → ChatList?
-
Chat list in which to search messages; pass null to search in all chats regardless of their chat list. Only Main and Archive chat lists are supported
final
- filter → SearchMessagesFilter?
-
Additional filter for messages to search; pass null to search for all messages. Filters searchMessagesFilterMention, searchMessagesFilterUnreadMention, searchMessagesFilterUnreadReaction, searchMessagesFilterFailedToSend, and searchMessagesFilterPinned are unsupported in this function
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- limit → int
-
The maximum number of messages to be returned; up to 100. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
final
- maxDate → int
-
If not 0, the maximum date of the messages to return
final
- minDate → int
-
If not 0, the minimum date of the messages to return
final
- offset → String
-
Offset of the first entry to return as received from the previous request; use empty string to get the first chunk of results
final
- query → String
-
Query to search for
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
Methods
-
copyWith(
{ChatList? chatList()?, String? query, String? offset, int? limit, SearchMessagesFilter? filter()?, int? minDate, int? maxDate}) → SearchMessages -
Returns a copy with the given fields replaced. For a nullable
field pass a function, e.g.
field: () => nullto clear it. -
getConstructor(
) → String -
TDLib function name, e.g.
getMe.override -
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
[dynamic extra]) → Map< String, dynamic> -
Converts this request to TDLib JSON, tagged with
extraif given.override -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Constants
- CONSTRUCTOR → const String
- TDLib type name.