mastodon-cpp
0.20.0
|
Class to hold attachments. More...
#include <attachment.hpp>
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... | |
Class to hold attachments.
|
explicit |
Attachment::Attachment | ( | ) |
double Attachment::aspect | ( | ) | const |
Aspect of original image.
double Attachment::aspect_small | ( | ) | const |
Aspect of preview image.
uint_fast64_t Attachment::bitrate | ( | ) | const |
Returns the bitrate of a video.
const string Attachment::description | ( | ) | const |
Returns the image description.
Attachment Attachment::description | ( | const string & | description | ) |
Sets the image description.
const std::chrono::duration< double > Attachment::duration | ( | ) | const |
Returns the duration of a video in seconds.
const string Attachment::file | ( | ) | const |
Gets file to upload.
Attachment Attachment::file | ( | const string & | file | ) |
Sets file to upload.
file | Filename |
const std::array< double, 2 > Attachment::focus | ( | ) | const |
Returns the focus point (x, y)
Values are between -1.0 and 1.0.
Attachment Attachment::focus | ( | const std::array< double, 2 > & | focus | ) |
Sets the focus point (x, y)
Values are between -1.0 and 1.0.
double Attachment::framerate | ( | ) | const |
Returns the framerate of a video in frames per second.
uint_fast64_t Attachment::height | ( | ) | const |
Returns the height of the original image.
uint_fast64_t Attachment::height_small | ( | ) | const |
Returns the height of the preview image.
std::uint_fast64_t Attachment::id | ( | ) | const |
Returns the ID of the attachment.
const string Attachment::preview_url | ( | ) | const |
Returns the URL of the preview image.
const string Attachment::remote_url | ( | ) | const |
Returns the remote URL of the original image.
const string Attachment::size | ( | ) | const |
Returns the size of the original image.
const string Attachment::size_small | ( | ) | const |
Returns the size of the preview image.
const string Attachment::text_url | ( | ) | const |
Returns shorter URL for the image.
Easy::attachment_type Attachment::type | ( | ) | const |
Returns attachment type.
const string Attachment::url | ( | ) | const |
Returns URL of the locally hosted version of the image.
|
virtual |
Returns true if the Entity holds valid data.
Implements Mastodon::Easy::Entity.
uint_fast64_t Attachment::width | ( | ) | const |
Returns the width of the original image.
uint_fast64_t Attachment::width_small | ( | ) | const |
Returns the width of the preview image.