Mastodon::Easy::Attachment Class Reference

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. More...
virtual bool	valid () const
	Returns true if the Entity holds valid data. More...
double	aspect () const
	Aspect of original image. More...
double	aspect_small () const
	Aspect of preview image. More...
uint_fast64_t	bitrate () const
	Returns the bitrate of a video. More...
const string	description () const
	Returns the image description. More...
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. More...
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...
double	framerate () const
	Returns the framerate of a video in frames per second. More...
uint_fast64_t	height () const
	Returns the height of the original image. More...
uint_fast64_t	height_small () const
	Returns the height of the preview image. More...
uint_fast64_t	id () const
	Returns the ID of the attachment. More...
const string	preview_url () const
	Returns the URL of the preview image. More...
const string	remote_url () const
	Returns the remote URL of the original image. More...
const string	size () const
	Returns the size of the original image. More...
const string	size_small () const
	Returns the size of the preview image. More...
const string	text_url () const
	Returns shorter URL for the image. More...
attachment_type	type () const
	Returns attachment type. More...
const string	url () const
	Returns URL of the locally hosted version of the image. More...
uint_fast64_t	width () const
	Returns the width of the original image. More...
uint_fast64_t	width_small () const
	Returns the width of the preview image. More...
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. More...
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 string	error () const
	Returns error string sent by the server. More...
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...
uint_fast64_t	get_uint64 (const string &key) const
	Returns the value of key as std::uint_fast64_t. More...
double	get_double (const string &key) const
	Returns the value of key as double. More...
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...
void	set (const string &key, const Json::Value &value)
	Sets the value of key. More...
std::uint_fast64_t	stouint64 (const string &str) const
bool	check_valid (const std::vector< string > &attributes) const
	Checks if an Entity is valid. More...

Detailed Description

Class to hold attachments.

Since

before 0.11.0

Constructor & Destructor Documentation

Attachment() [1/2]

Attachment::Attachment ( const string &  json )

explicit

Constructs an Attachment object from a JSON string.

Parameters

json	JSON string

Since

before 0.11.0

: Entity(json)
{}

Attachment() [2/2]

Attachment::Attachment

(

)

Constructs an empty Attachment object.

Since

before 0.11.0

: Entity()
{}

Member Function Documentation

aspect()

double Attachment::aspect

(

)

const

Aspect of original image.

Since

before 0.11.0

{
    return get_double("meta.original.aspect");
}

aspect_small()

double Attachment::aspect_small

(

)

const

Aspect of preview image.

Since

before 0.11.0

{
    return get_double("meta.small.aspect");
}

bitrate()

uint_fast64_t Attachment::bitrate

(

)

const

Returns the bitrate of a video.

Since

before 0.11.0

{
    return get_uint64("meta.original.bitrate");
}

description() [1/2]

const string Attachment::description

(

)

const

Returns the image description.

Since

before 0.11.0

{
    return get_string("description");
}

description() [2/2]

Attachment Attachment::description

(

const string &

description

)

Sets the image description.

Since

0.17.0

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

duration()

const std::chrono::duration< double > Attachment::duration

(

)

const

Returns the duration of a video in seconds.

Since

before 0.11.0

{
    const double sec = get_double("meta.original.duration");

    return std::chrono::duration<double>(sec);
}

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.

Since

before 0.11.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)

Values are between -1.0 and 1.0.

Since

0.17.0

{
    set("meta.focus.x", Json::Value(focus[0]));
    set("meta.focus.y", Json::Value(focus[1]));
    return *this;
}

framerate()

double Attachment::framerate

(

)

const

Returns the framerate of a video in frames per second.

Since

before 0.11.0

{
    string strframes = get_string("meta.original.frame_rate");

    if (!strframes.empty())
    {
        std::size_t pos = strframes.find('/');
        if (pos != std::string::npos)
        {
            std::uint_fast16_t frames = std::stoul(strframes.substr(0, pos));
            std::uint_fast16_t divider = std::stoul(strframes.substr(pos + 1));

            return frames / divider;
        }
    }

    return 0.0;
}

height()

uint_fast64_t Attachment::height

(

)

const

Returns the height of the original image.

Since

before 0.11.0

{
    return get_uint64("meta.original.height");
}

height_small()

uint_fast64_t Attachment::height_small

(

)

const

Returns the height of the preview image.

Since

before 0.11.0

{
    return get_uint64("meta.small.height");
}

id()

std::uint_fast64_t Attachment::id

(

)

const

Returns the ID of the attachment.

Since

before 0.11.0

{
    return stouint64(get_string("id"));
}

preview_url()

const string Attachment::preview_url

(

)

const

Returns the URL of the preview image.

Since

before 0.11.0

{
    return get_string("preview_url");
}

remote_url()

const string Attachment::remote_url

(

)

const

Returns the remote URL of the original image.

Since

before 0.11.0

{
    return get_string("remote_url");
}

size()

const string Attachment::size

(

)

const

Returns the size of the original image.

Since

before 0.11.0

{
    return get_string("meta.original.size");
}

size_small()

const string Attachment::size_small

(

)

const

Returns the size of the preview image.

Since

before 0.11.0

{
    return get_string("meta.small.size");
}

text_url()

const string Attachment::text_url

(

)

const

Returns shorter URL for the image.

Since

before 0.11.0

{
    return get_string("text_url");
}

type()

Easy::attachment_type Attachment::type

(

)

const

Returns attachment type.

Since

before 0.11.0

{
    const string strtype = get_string("type");
    if (strtype.compare("image") == 0)
        return attachment_type::Image;
    else if (strtype.compare("video") == 0)
        return attachment_type::Video;
    else if (strtype.compare("gifv") == 0)
        return attachment_type::Gifv;
    else if (strtype.compare("unknown") == 0)
        return attachment_type::Unknown;

    ttdebug << "Could not get data: type\n";
    return attachment_type::Undefined;
}

url()

const string Attachment::url

(

)

const

Returns URL of the locally hosted version of the image.

Since

before 0.11.0

{
    return get_string("url");
}

valid()

bool Attachment::valid ( ) const

virtual

Returns true if the Entity holds valid data.

Since

before 0.11.0 (virtual since 0.18.2)

Implements Mastodon::Easy::Entity.

{
    const std::vector<string> attributes =
    {{
        "id",
        "type",
        "url",
        "preview_url"
    }};

    return Entity::check_valid(attributes);
}

width()

uint_fast64_t Attachment::width

(

)

const

Returns the width of the original image.

Since

before 0.11.0

{
    return get_uint64("meta.original.width");
}

width_small()

uint_fast64_t Attachment::width_small

(

)

const

Returns the width of the preview image.

Since

before 0.11.0

{
    return get_uint64("meta.small.width");
}

---

The documentation for this class was generated from the following files:

• src/easy/entities/attachment.hpp
• src/easy/entities/attachment.cpp