Class to hold attachments. More...

#include <attachment.hpp>

Inheritance diagram for Mastodon::Easy::Attachment:

Public Member Functions
	Attachment (const string &json)
	Constructs an Attachment object from a JSON string. More...

	Attachment ()
	Constructs an empty Attachment object.

const double	aspect () const
	Aspect of original image.

const double	aspect_small () const
	Aspect of preview image.

const uint_fast64_t	bitrate () const
	Returns the bitrate of a video.

const string	description () const
	Returns the image description.

Attachment	description (const string &description)
	Sets the image description. More...

const std::chrono::duration< double >	duration () const
	Returns the duration of a video in seconds.

const string	file () const
	Gets file to upload. More...

Attachment	file (const string &file)
	Sets file to upload. More...

const std::array< double, 2 >	focus () const
	Returns the focus point (x, y) More...

Attachment	focus (const std::array< double, 2 > &focus)
	Sets the focus point (x, y) More...

const double	framerate () const
	Returns the framerate of a video in frames per second.

const uint_fast64_t	height () const
	Returns the height of the original image.

const uint_fast64_t	height_small () const
	Returns the height of the preview image.

const uint_fast64_t	id () const
	Returns the ID of the attachment.

const string	preview_url () const
	Returns the URL of the preview image.

const string	remote_url () const
	Returns the remote URL of the original image.

const string	size () const
	Returns the size of the original image.

const string	size_small () const
	Returns the size of the preview image.

const string	text_url () const
	Returns shorter URL for the image.

const attachment_type	type () const
	Returns attachment type.

const string	url () const
	Returns URL of the locally hosted version of the image.

const uint_fast64_t	width () const
	Returns the width of the original image.

const uint_fast64_t	width_small () const
	Returns the width of the preview image.

Public Member Functions inherited from Mastodon::Easy::Entity
	Entity (const string &json)
	Constructs an Entity object from a JSON string. More...

	Entity ()
	Constructs an empty Entity object.

const void	from_string (const string &json)
	Replaces the Entity with a new one from a JSON string. More...

const Json::Value	to_object () const
	Returns the JSON object of the Entity. More...

const bool	valid () const
	Returns true if the Entity holds valid data.

const string	error () const
	Returns error string sent by the server.

const bool	was_set () const
	Returns true if the last requested value was set, false if it was unset. More...

Additional Inherited Members
Protected Member Functions inherited from Mastodon::Easy::Entity
const Json::Value	get (const string &key) const
	Returns the value of key as Json::Value. More...

const string	get_string (const string &key) const
	Returns the value of key as std::string. More...

const uint_fast64_t	get_uint64 (const string &key) const
	Returns the value of key as std::uint_fast64_t. More...

const double	get_double (const string &key) const
	Returns the value of key as double. More...

const bool	get_bool (const string &key) const
	Returns the value of key as bool. More...

const system_clock::time_point	get_time_point (const string &key) const
	Returns the value of key as time_point. More...

const std::vector< string >	get_vector (const string &key) const
	Returns the value of key as vector. More...

const void	set (const string &key, const Json::Value &value)
	Sets the value of key. More...

const std::uint_fast64_t	stouint64 (const string &str) const

Detailed Description

Class to hold attachments.

Constructor & Destructor Documentation

◆ Attachment()

Attachment::Attachment ( const string & json )

explicit

Constructs an Attachment object from a JSON string.

Parameters

json	JSON string

25 : Entity(json)

26 {}

Mastodon::Easy::Entity::Entity

Entity()

Constructs an empty Entity object.

Definition: entity.cpp:70

Member Function Documentation

◆ description()

Attachment Attachment::description ( const string & description )

Sets the image description.

Since: 0.17.0

 {
     set("description", Json::Value(description));
     return *this;
 }

◆ file() [1/2]

const string Attachment::file ( ) const

Gets file to upload.

Since: 0.17.0

 {
     return get_string("file");
 }

◆ file() [2/2]

Attachment Attachment::file ( const string & file )

Sets file to upload.

Since: 0.17.0

Parameters

file Filename

 {
     set("file", Json::Value(file));
     return *this;
 }

◆ focus() [1/2]

const std::array< double, 2 > Attachment::focus ( ) const

Returns the focus point (x, y)

Values are between -1.0 and 1.0.

 {
     const Json::Value x = get("meta.focus.x");
     const Json::Value y = get("meta.focus.y");
     if (x.isDouble() && y.isDouble())
     {
         return
         {{
             x.asDouble(),
             y.asDouble()
         }};
     }
 
     return {};
 }

◆ focus() [2/2]

Attachment Attachment::focus ( const std::array< double, 2 > & focus )

Sets the focus point (x, y)