This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). https://core.telegram.org/bots/api#animation. More...

#include <Animation.hpp>

Public Member Functions
	Animation ()=default

	Animation (const nl::json &json)

nl::json	toJson () const
	Serializes this object to JSON. More...

void	fromJson (const nl::json &json)
	Deserializes this object from JSON. More...

Public Attributes
std::string	fileId
	Identifier for this file, which can be used to download or reuse the file. More...

std::string	fileUniqueId
	Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file. More...

std::int32_t	width {}
	Video width as defined by sender. More...

std::int32_t	height {}
	Video height as defined by sender. More...

std::int32_t	duration {}
	Duration of the video in seconds as defined by sender. More...

Ptr< PhotoSize >	thumbnail
	Optional. Animation thumbnail as defined by sender. More...

std::string	fileName
	Optional. Original animation filename as defined by sender. More...

std::string	mimeType
	Optional. MIME type of the file as defined by sender. More...

std::int64_t	fileSize {}
	Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value. More...

Detailed Description

This object represents an animation file (GIF or H.264/MPEG-4 AVC video without sound). https://core.telegram.org/bots/api#animation.

Definition at line 8 of file Animation.hpp.

Constructor & Destructor Documentation

◆ Animation() [1/2]

tgbotxx::Animation::Animation ( )

default

◆ Animation() [2/2]

tgbotxx::Animation::Animation ( const nl::json & json )

inlineexplicit

Definition at line 10 of file Animation.hpp.

Member Function Documentation

◆ fromJson()

void tgbotxx::Animation::fromJson ( const nl::json & json )

inline

Deserializes this object from JSON.

Definition at line 61 of file Animation.hpp.

◆ toJson()

nl::json tgbotxx::Animation::toJson ( ) const

inline

Serializes this object to JSON.

Returns: JSON representation of this object

Definition at line 46 of file Animation.hpp.

Member Data Documentation

◆ duration

std::int32_t tgbotxx::Animation::duration {}

Duration of the video in seconds as defined by sender.

Definition at line 28 of file Animation.hpp.

◆ fileId

std::string tgbotxx::Animation::fileId

Identifier for this file, which can be used to download or reuse the file.

Definition at line 15 of file Animation.hpp.

◆ fileName

std::string tgbotxx::Animation::fileName

Optional. Original animation filename as defined by sender.

Definition at line 34 of file Animation.hpp.

◆ fileSize

std::int64_t tgbotxx::Animation::fileSize {}

Optional. File size in bytes. It can be bigger than 2^31 and some programming languages may have difficulty/silent defects in interpreting it. But it has at most 52 significant bits, so a signed 64-bit integer or double-precision float type are safe for storing this value.

Definition at line 42 of file Animation.hpp.

◆ fileUniqueId

std::string tgbotxx::Animation::fileUniqueId

Unique identifier for this file, which is supposed to be the same over time and for different bots. Can't be used to download or reuse the file.

Definition at line 19 of file Animation.hpp.

◆ height

std::int32_t tgbotxx::Animation::height {}

Video height as defined by sender.

Definition at line 25 of file Animation.hpp.

◆ mimeType

std::string tgbotxx::Animation::mimeType

Optional. MIME type of the file as defined by sender.

Definition at line 37 of file Animation.hpp.

◆ thumbnail

Ptr<PhotoSize> tgbotxx::Animation::thumbnail

Optional. Animation thumbnail as defined by sender.

Definition at line 31 of file Animation.hpp.

◆ width

std::int32_t tgbotxx::Animation::width {}

Video width as defined by sender.

Definition at line 22 of file Animation.hpp.

The documentation for this struct was generated from the following file:

include/tgbotxx/objects/Animation.hpp

Public Member Functions

Public Attributes