mastodon-cpp  0.110.0
card.hpp
1 /* This file is part of mastodon-cpp.
2  * Copyright © 2018, 2019 tastytea <tastytea@tastytea.de>
3  *
4  * This program is free software: you can redistribute it and/or modify
5  * it under the terms of the GNU Affero General Public License as published by
6  * the Free Software Foundation, version 3.
7  *
8  * This program is distributed in the hope that it will be useful,
9  * but WITHOUT ANY WARRANTY; without even the implied warranty of
10  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11  * GNU Affero General Public License for more details.
12  *
13  * You should have received a copy of the GNU Affero General Public License
14  * along with this program. If not, see <http://www.gnu.org/licenses/>.
15  */
16 
17 #ifndef MASTODON_CPP_EASY_CARD_HPP
18 #define MASTODON_CPP_EASY_CARD_HPP
19 
20 #include <string>
21 #include <cstdint>
22 
23 #include "../../mastodon-cpp.hpp"
24 #include "../entity.hpp"
25 
26 using std::string;
27 using std::uint64_t;
28 
29 namespace Mastodon
30 {
31 namespace Easy
32 {
38  class Card : public Entity
39  {
40  public:
41  using Entity::Entity;
42 
43  virtual bool valid() const override;
44 
50  const string author_name() const;
51 
57  const string author_url() const;
58 
64  const string description() const;
65 
73  const string embed_url() const;
74 
80  uint64_t height() const;
81 
87  const string html() const;
88 
94  const string image() const;
95 
101  const string provider_name() const;
102 
108  const string provider_url() const;
109 
115  const string title() const;
116 
122  Easy::card_type type() const;
123 
129  const string url() const;
130 
136  uint64_t width() const;
137  };
138 }
139 }
140 
141 #endif // MASTODON_CPP_EASY_CARD_HPP
const string provider_url() const
Returns the URL of the provider.
Definition: card.cpp:74
Entity()
Constructs an empty Entity object.
Definition: entity.cpp:43
Class to hold cards.
Definition: card.hpp:38
Easy::card_type type() const
Returns the type of the card.
Definition: card.cpp:84
const string title() const
Returns the title.
Definition: card.cpp:79
const string description() const
Returns the description.
Definition: card.cpp:44
const string embed_url() const
Returns the embed URL.
Definition: card.cpp:49
const string author_url() const
Returns the URL of the author.
Definition: card.cpp:39
uint64_t height() const
Returns the height of the card.
Definition: card.cpp:54
const string url() const
Returns the URL associated with the card.
Definition: card.cpp:99
const string author_name() const
Returns the name of the author.
Definition: card.cpp:34
const string provider_name() const
Returns the name of the provider.
Definition: card.cpp:69
virtual bool valid() const override
Returns true if the Entity holds valid data.
Definition: card.cpp:23
uint64_t width() const
Returns the width of the card.
Definition: card.cpp:104
Collection of things to interface with server software that implements the Mastodon API.
Definition: mastodon-cpp.hpp:47
Base class for all entities.
Definition: entity.hpp:36
const string image() const
Returns the URL of the image associated with the card.
Definition: card.cpp:64
const string html() const
Returns the HTML.
Definition: card.cpp:59
card_type
Describes the card type.
Definition: types_easy.hpp:83