Message.reply_animation()¶
- async Message.reply_animation()[source]¶
Bound method reply_animation
Message
.Use as a shortcut for:
await client.send_animation( chat_id=message.chat.id, message_thread_id=message.message_thread_id, animation=animation, )
Example
await message.reply_animation(animation)
- Parameters:
animation (
str
) – Animation to send. Pass a file_id as string to send an animation that exists on the Telegram servers, pass an HTTP URL as a string for Telegram to get an animation from the Internet, or pass a file path as string to upload a new animation that exists on your local machine.quote (
bool
, optional) – IfTrue
, the message will be sent as a reply to this message. If reply_to_message_id is passed, this parameter will be ignored. Defaults toTrue
in group chats andFalse
in private chats.caption (
str
, optional) – Animation caption, 0-1024 characters.parse_mode (
ParseMode
, optional) – By default, texts are parsed using both Markdown and HTML styles. You can combine both syntaxes together.caption_entities (List of
MessageEntity
) – List of special entities that appear in the caption, which can be specified instead of parse_mode.has_spoiler (
bool
, optional) – Pass True if the animation needs to be covered with a spoiler animation.duration (
int
, optional) – Duration of sent animation in seconds.width (
int
, optional) – Animation width.height (
int
, optional) – Animation height.thumb (
str | BinaryIO
, optional) – Thumbnail of the animation file sent. The thumbnail should be in JPEG format and less than 200 KB in size. A thumbnail’s width and height should not exceed 320 pixels. Thumbnails can’t be reused and can be only uploaded as a new file.disable_notification (
bool
, optional) – Sends the message silently. Users will receive a notification with no sound.reply_to_message_id (
int
, optional) – If the message is a reply, ID of the original message.reply_markup (
InlineKeyboardMarkup
|ReplyKeyboardMarkup
|ReplyKeyboardRemove
|ForceReply
, optional) – Additional interface options. An object for an inline keyboard, custom reply keyboard, instructions to remove reply keyboard or to force a reply from the user.progress (
Callable
, optional) – Pass a callback function to view the file transmission progress. The function must take (current, total) as positional arguments (look at Other Parameters below for a detailed description) and will be called back each time a new file chunk has been successfully transmitted.progress_args (
tuple
, optional) – Extra custom arguments for the progress callback function. You can pass anything you need to be available in the progress callback scope; for example, a Message object or a Client instance in order to edit the message with the updated progress status.
- Other Parameters:
current (
int
) – The amount of bytes transmitted so far.total (
int
) – The total size of the file.*args (
tuple
, optional) – Extra custom arguments as defined in theprogress_args
parameter. You can either keep*args
or add every single extra argument in your function signature.
- Returns:
On success, the sent
Message
is returned. In case the upload is deliberately stopped withstop_transmission()
, None is returned instead.- Raises:
RPCError – In case of a Telegram RPC error.