SearchSavedMessages class final
Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing message_id For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
Returns FoundChatMessages.
- Inheritance
-
- Object
- TdFunction<
FoundChatMessages> - SearchSavedMessages
Constructors
- SearchSavedMessages({required int savedMessagesTopicId, ReactionType? tag, required String query, required int fromMessageId, required int offset, required int limit})
-
Searches for messages tagged by the given reaction and with the given words in the Saved Messages chat; for Telegram Premium users only. Returns the results in reverse chronological order, i.e. in order of decreasing 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 - fromMessageId → int
-
Identifier of the message starting from which messages must be fetched; use 0 to get results from the last message
final
- hashCode → int
-
The hash code for this object.
no setterinherited
- limit → int
-
The maximum number of messages to be returned; must be positive and can't be greater than 100. If the offset is negative, the limit must be greater than -offset. For optimal performance, the number of returned messages is chosen by TDLib and can be smaller than the specified limit
final
- offset → int
-
Specify 0 to get results from exactly the message from_message_id or a negative offset to get the specified message and some newer messages
final
- query → String
-
Query to search for
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- savedMessagesTopicId → int
-
If not 0, only messages in the specified Saved Messages topic will be considered; pass 0 to consider all messages
final
- tag → ReactionType?
-
Tag to search for; pass null to return all suitable messages
final
Methods
-
copyWith(
{int? savedMessagesTopicId, ReactionType? tag()?, String? query, int? fromMessageId, int? offset, int? limit}) → SearchSavedMessages -
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.