/* This file is part of mastodon-cpp. * Copyright © 2018 tastytea * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by * the Free Software Foundation, version 3. * * This program is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU General Public License for more details. * * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ #ifndef MASTODON_CPP_EASY_ATTACHMENT_HPP #define MASTODON_CPP_EASY_ATTACHMENT_HPP #include #include #include #include // If we are compiling mastodon-cpp, use another include path #ifdef MASTODON_CPP #include "mastodon-cpp.hpp" #include "easy/easy.hpp" #else #include #include #endif using std::string; using std::uint_fast64_t; namespace Mastodon { /*! * @brief Class to hold attachments */ class Easy::Attachment : public Easy::Entity { public: /*! * @brief Constructs an Attachment object from a JSON string. * * @param json JSON string */ explicit Attachment(const string &json); /*! * @brief Constructs an empty Attachment object. */ Attachment(); /*! * @brief Aspect of original image */ const double aspect() const; /*! * @brief Aspect of preview image */ const double aspect_small() const; /*! * @brief Returns the bitrate of a video */ const uint_fast64_t bitrate() const; /*! * @brief Returns the image description */ const string description() const; /*! * @brief Returns the duration of a video in seconds */ const std::chrono::duration duration() const; /*! * @brief Returns the focus point (x, y) * * Values are between -1.0 and 1.0. */ const std::array focus() const; /*! * @brief Returns the framerate of a video in frames per second */ const double framerate() const; /*! * @brief Returns the height of the original image */ const uint_fast64_t height() const; /*! * @brief Returns the height of the preview image */ const uint_fast64_t height_small() const; /*! * @brief Returns the ID of the attachment */ const uint_fast64_t id() const; /*! * @brief Returns the URL of the preview image */ const string preview_url() const; /*! * @brief Returns the remote URL of the original image */ const string remote_url() const; /*! * @brief Returns the size of the original image */ const string size() const; /*! * @brief Returns the size of the preview image */ const string size_small() const; /*! * @brief Returns shorter URL for the image */ const string text_url() const; /*! * @brief Returns attachment type */ const attachment_type type() const; /*! * @brief Returns URL of the locally hosted version of the image */ const string url() const; /*! * @brief Returns the width of the original image */ const uint_fast64_t width() const; /*! * @brief Returns the width of the preview image */ const uint_fast64_t width_small() const; }; } #endif // MASTODON_CPP_EASY_ATTACHMENT_HPP