This repository has been archived on 2020-05-10. You can view files and clone it, but cannot push or open issues or pull requests.
mastodon-cpp/src/easy/entities/card.hpp

137 lines
3.2 KiB
C++
Raw Normal View History

2018-03-25 19:43:48 +02:00
/* This file is part of mastodon-cpp.
2019-03-20 06:15:43 +01:00
* Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
*
2018-03-25 19:43:48 +02:00
* 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 <http://www.gnu.org/licenses/>.
*/
#ifndef MASTODON_CPP_EASY_CARD_HPP
#define MASTODON_CPP_EASY_CARD_HPP
#include <string>
#include <cstdint>
#include "easy/entity.hpp"
2018-03-25 19:43:48 +02:00
// If we are compiling mastodon-cpp, use another include path
#ifdef MASTODON_CPP
#include "mastodon-cpp.hpp"
2018-04-01 03:36:11 +02:00
#include "easy/easy.hpp"
2018-03-25 19:43:48 +02:00
#else
#include <mastodon-cpp/mastodon-cpp.hpp>
2018-04-01 03:36:11 +02:00
#include <mastodon-cpp/easy/easy.hpp>
2018-03-25 19:43:48 +02:00
#endif
using std::string;
using std::uint64_t;
2018-03-25 19:43:48 +02:00
namespace Mastodon
{
/*!
* @brief Class to hold cards
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
class Easy::Card : public Easy::Entity
{
public:
2019-03-11 20:48:54 +01:00
using Entity::Entity;
2018-03-30 20:16:31 +02:00
2018-12-04 11:26:28 +01:00
virtual bool valid() const;
2018-03-25 19:43:48 +02:00
/*!
* @brief Returns the name of the author
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string author_name() const;
/*!
* @brief Returns the URL of the author
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string author_url() const;
/*!
* @brief Returns the description
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string description() const;
/*!
* @brief Returns the height of the card
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
uint64_t height() const;
2018-03-25 19:43:48 +02:00
/*!
* @brief Returns the HTML
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string html() const;
/*!
* @brief Returns the URL of the image associated with the card
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string image() const;
/*!
* @brief Returns the name of the provider
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string provider_name() const;
/*!
* @brief Returns the URL of the provider
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string provider_url() const;
/*!
* @brief Returns the title
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string title() const;
/*!
* @brief Returns the type of the card
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
2018-12-04 11:26:28 +01:00
Easy::card_type type() const;
2018-03-25 19:43:48 +02:00
/*!
* @brief Returns the URL associated with the card
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
const string url() const;
/*!
* @brief Returns the width of the card
*
* @since before 0.11.0
2018-03-25 19:43:48 +02:00
*/
uint64_t width() const;
2018-03-25 19:43:48 +02:00
};
}
#endif // MASTODON_CPP_EASY_CARD_HPP